https://github.com/adriankumpf/alarmate

A Rust client for interacting with the LUPUSEC XT2 alarm panel API.
https://github.com/adriankumpf/alarmate

alarm-panel lupusec lupusec-alarm smart-home

Last synced: 4 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/adriankumpf/alarmate
Owner: adriankumpf
License: mit
Created: 2018-12-26T13:07:44.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2025-01-18T14:01:28.000Z (4 months ago)
Last Synced: 2025-01-18T15:14:12.669Z (4 months ago)
Topics: alarm-panel, lupusec, lupusec-alarm, smart-home
Language: Rust
Homepage:
Size: 153 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

README

# Alarmate

A Rust client for interacting with the LUPUSEC XT2 API.

## Installation

### Binary

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

### Library

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

## Usage

### Binary

```bash
$ alarmate --help

Usage: alarmate

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
```

### Library

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

let mut client = Client::new("admin", "changeme", "10.0.0.10".parse()?);
client.change_mode(Area::Area1, &Mode::Disarmed)?;
```

## Documentation

```bash
cargo doc --open
```

## Project status

This library only supports the XT2 alarm panel. Other LUPUSUC 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](https://choosealicense.com/licenses/mit/)