Skip to content

Releases: verheesj/reolink-aio-ts

v0.1.0-alpha.1

15 Nov 14:40

Choose a tag to compare

v0.1.0-alpha.1 Pre-release
Pre-release

v0.1.0-alpha.0

14 Nov 16:42

Choose a tag to compare

v0.1.0-alpha.0 Pre-release
Pre-release

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

Unreleased

0.1.0-alpha.0 - 2025-11-14

Added - Initial Release

This is the first pre-release of reolink-aio - a TypeScript implementation of Reolink's Baichuan API (the same API used by official Reolink iOS/Android apps and CLI).

Core Features

  • Full TypeScript Support - Complete type safety and IntelliSense
  • HTTP API Client - Comprehensive REST API implementation
  • Baichuan Protocol - Real-time push events via TCP
  • NVR & Camera Support - Works with both standalone cameras and NVR systems
  • Session Management - Automatic token refresh and connection handling
  • Error Handling - Rich exception hierarchy for robust error management

Real-Time Events

  • Motion Detection - Real-time motion alerts via Baichuan
  • AI Detection - Person, vehicle, pet/animal, face, and package detection
  • Visitor Detection - Doorbell button press events
  • State Monitoring - Continuous monitoring of camera states
  • Event Subscription - Subscribe to push notifications

Video & Media

  • VOD File Search - Find recordings by time range and event type
  • Video Download - Download MP4 clips from NVR/cameras
  • Multiple Streams - Support for main and sub streams
  • Stream URLs - Generate FLV, RTMP, and RTSP URLs

Device Control

  • IR Lights - Control infrared illumination
  • Spotlight - Toggle camera spotlight with brightness control
  • Siren - Activate camera siren/audio alarm (fully working!)
  • Focus Control - Set camera focus position
  • Zoom Control - Set camera zoom position

Device Information

  • Device Discovery - Automatic NVR/camera detection
  • Channel Management - Multi-channel support for NVRs
  • Capability Detection - Automatic feature detection
  • Model Information - Device model, firmware, hardware version
  • Network Settings - Port configuration (RTSP, RTMP, ONVIF)

Testing & Documentation

  • Comprehensive JSDoc documentation across all APIs
  • Unit tests for utilities, types, and Baichuan protocol
  • Working examples for common use cases
  • API documentation guide

Fixed

  • Baichuan TCP protocol XML formatting (critical blank line separator fix for siren/control commands)
  • Response future cleanup to prevent accumulation in long-running sessions

Known Limitations

  • PTZ control not yet implemented
  • Snapshot capture not yet implemented
  • Advanced configuration management (OSD, schedules, zones) not yet implemented
  • Integration tests pending
  • Code coverage ~30% (baseline established)

Breaking Changes

  • This is an initial pre-release; APIs may change in future versions

Notes

  • Based on the Python reolink-aio library
  • Published under the next dist-tag on npm
  • Requires Node.js 18+
  • TypeScript 5.3+