#protect #system-api #sdk #unifi #server #camera #key

unifi_protect

An SDK for interacting with a unifi protect server

16 unstable releases (3 breaking)

0.5.2 Feb 16, 2024
0.5.1 Feb 16, 2024
0.4.9 Feb 16, 2024
0.4.8 Aug 11, 2023
0.1.3 Jul 23, 2023

#2035 in Web programming

Download history 2/week @ 2024-07-29 1/week @ 2024-09-16 30/week @ 2024-09-23 7/week @ 2024-09-30

115 downloads per month
Used in unifi-protect-bulk-downlo…

GPL-3.0 license

29KB
791 lines

UniFi-Protect Rust Library

Crates.io Docs.rs Build Status

This library enables interacting with a unifi protect server (such as the one running on a ubiquiti cloud key gen2). It aims to eventually be a complete implementation of the unifi protect api in Rust, closely following the example of the javascript-based https://github.com/hjdhjd/unifi-protect/ It is also used in the unifi-protect-bulk-download tool for downloading footage from a unifi protect system.

To add the library to an existing cargo project: cargo add unifi-protect

Basic usage:

use unifi_protect::UnifiProtectServer;

// [ ...]
// within an async context:

// create a new instance using the base uri of the unifi protect server (same uri you would use to reach the system's web portal)
let mut server = UnifiProtectServer::new("BASE_URI"); // ( e.g. "https://192.168.1.28")
// login with username + password credentials (same credentials you would use to login to the system's web portal)
server
    .login("USERNAME", "PASSWORD")
    .await
    .expect("Failed to login");
server
    .fetch_cameras()
    .await
    .expect("Failed to fetch cameras");
println!("Found {} cameras", server.cameras.len());

Dependencies

~7–19MB
~255K SLoC