@2bad/tvt

TVT Device SDK

A modern TypeScript SDK for TVT CCTV devices, providing a clean and type-safe interface for device management, monitoring, and control. This project is the result of extensive research and reverse engineering of TVT (Tongwei Video Technology) CCTV systems.

🌟 Features

• Type-Safe API: Full TypeScript support with comprehensive type definitions
• Async/Await: Modern promise-based API for better control flow
• Lazy Loading: Efficient resource management with on-demand library loading
• Error Handling: Robust error handling with detailed error messages
• Logging: Built-in debug logging for easier troubleshooting
• Documentation: Extensive JSDoc documentation for all methods

📦 Installation

npm install tvt

🚀 Quick Start

import { Device } from 'tvt'

try {
  // Create and initialize a new device instance
  const device = await Device.create('192.168.1.100', 9008)

  // Login to the device
  await device.login('admin', 'password')

  // Get device information
  const info = await device.getInfo()
  console.log(`Connected to ${info.deviceName}`)

  // Capture a snapshot
  await device.saveSnapshot(0, '/path/to/snapshot.jpg')

  // Clean up
  await device.dispose()
} catch (error) {
  console.error('Error:', error)
}

🔧 Core Features

Device Management

• Device discovery
• Async connection management
• Authentication
• Device information retrieval

Security Features

• Alarm management
• Manual alarm triggering
• Event monitoring

Media Operations

• Snapshot capture
• Live stream management
• Video recording

📚 API Reference

Device Class

The main interface for interacting with TVT devices.

class Device {
  static create(ip: string, port?: number, settings?: Settings): Promise<Device>
  login(user: string, pass: string): Promise<boolean>
  logout(): Promise<boolean>
  getInfo(): Promise<DeviceInfo>
  triggerAlarm(value: boolean): Promise<boolean>
  saveSnapshot(channel: number, filePath: string): Promise<boolean>
  dispose(): Promise<boolean>
  // ... and more
}

See API Documentation for detailed method descriptions.

🛠️ Development

Prerequisites

• Node.js 18 or higher
• Linux operating system (required for SDK operations)

Building from Source

git clone https://github.com/yourusername/tvt.git
cd tvt
npm install
npm run build

Running Tests

npm test

📁 Project Structure

tvt/
├── bin/            # Precompiled SDK libraries
├── docs/           # Documentation and examples
├── proto/          # Protocol definitions and dissectors
└── source/         # TypeScript implementation
    ├── lib/        # Core SDK implementation
    ├── helpers/    # Utility functions
    └── types/      # TypeScript type definitions

🔄 Migration from v1.x to v2.x

Breaking Changes

• All SDK methods now return Promises and require await:

// Before
const info = device.info

// After
const info = await device.getInfo()

• Device creation is now async and uses a factory method:

// Before
const device = new Device('192.168.1.100')

// After
const device = await Device.create('192.168.1.100')

• Property access changes:

// Before
device.info.deviceName

// After
const info = await device.getInfo()
info.deviceName

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Guidelines

• Follow TypeScript best practices
• Include tests for new features
• Update documentation as needed
• Follow the existing code style

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Disclaimer

This project is not officially associated with TVT Digital Technology Co., Ltd. It is an independent implementation based on research and reverse engineering. Use at your own risk.

🙏 Acknowledgments

• TVT Digital Technology for their CCTV systems
• The open-source community for various tools and libraries used in this project
• Contributors who have helped improve this SDK

📬 Support

• Create an issue for bug reports or feature requests