https://github.com/compatech/pyspcflexgw
https://github.com/compatech/pyspcflexgw
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/compatech/pyspcflexgw
- Owner: CoMPaTech
- License: mit
- Created: 2020-10-26T11:31:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-26T11:32:20.000Z (over 5 years ago)
- Last Synced: 2025-03-30T16:15:57.879Z (over 1 year ago)
- Language: Python
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Python library for communicating with [Vanderbilt SPC alarm systems](https://vanderbiltindustries.com/spc) via the REST/websocket API provided by the SPC Web Gateway software made by [Lundix IT](http://www.lundix.se/smarta-losningar/). Using this library you can:
- Retrieve information for all alarm areas and zones.
- Change the alarm mode, i.e. arming and disarming of the alarm system.
- Get real-time updates when attributes of areas and zones change, e.g. if motion detector connected to the systems triggers or when the alarm goes off.
## Usage
### Library
To use the library in your own application see the example file.
### Stand-alone
When installing the package an interactive test shell is automatically installed. To run it:
```
spcwebgw-console
```
Where ``````is the url of the SPC Web Gateway API and `````` is the url of the SPC Web Gateway websocket endpoint.
Examples of available commands in the test shell:
- ```areas```. List all available areas.
- ```zones```. List all available zones or only zones in a specific area.
- ```full_set```. Full set an area.
- ```part_set_x```. Part set x an area.
- ```unset```. Unset an area.
- ```debug```. Toggle debug output.