Skip to content

adriankumpf/alarmate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alarmate

A Rust client for interacting with the LUPUSEC XT2 API.

Installation

Binary

cargo build --release --features="build-binary"

Library

[dependencies]
alarmate = { git = "https://github.com/adriankumpf/alarmate", tag = "v0.4.0" }

Usage

Binary

$ alarmate --help

Usage: alarmate <COMMAND>

Commands:
  devices  List devices
  status   Get current status
  mode     Change mode
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help information

Connection options (-I, -U, -P) are required for all commands and can also be set via environment variables:

Flag Environment Variable
-I, --ip-address ALARMATE_IP_ADDRESS
-U, --username ALARMATE_USERNAME
-P, --password ALARMATE_PASSWORD

Library

use alarmate::{Area, Client, Mode};

#[tokio::main]
async fn main() -> alarmate::Result {
    let mut client = Client::new("admin", "changeme", "192.168.178.10".parse().unwrap())?;
    client.change_mode(Area::Area1, Mode::Disarmed).await?;
    Ok(())
}

Documentation

cargo doc --open

Project status

This library only supports the XT2 alarm panel. Other LUPUSEC alarm panels probably won't work due to differing APIs.

Currently there is only a limited feature set available. Please open a PR or an issue if you feel there is something missing!

License

MIT

About

A Rust client for interacting with the LUPUSEC XT2 alarm panel API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages