A Python library for communicating with SPC Web Gateway.
Project description
Python library for communicating with Vanderbilt SPC alarm systems via the REST/websocket API provided by the SPC Web Gateway software made by Lundix IT. 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 <API url> <WS url>
Where <API url>is the url of the SPC Web Gateway API and <WS url> 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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyspcwebgw-0.2.0.tar.gz.
File metadata
- Download URL: pyspcwebgw-0.2.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1006136586717216c365e5c8d731b8ba08d512fd38747403eb9d7491ba7495b |
|
| MD5 | 13efbf76834f28f1f4dcd147c1a0818c |
|
| BLAKE2b-256 | f08ac916c57f94082b74a283de0863b1b7661de0d8166182470f3c265fcb41fb |
Provenance
File details
Details for the file pyspcwebgw-0.2.0-py3-none-any.whl.
File metadata
- Download URL: pyspcwebgw-0.2.0-py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3c0cf959af330dbf7816f99f3de5d9b74971d12627ba10b479f7bbaa44be24f2 |
|
| MD5 | 8c6aac377b603856f945285f521b75ac |
|
| BLAKE2b-256 | 0cdbe2f741b951ee7baba1432a0a316cf22b02f1c79d810d730effc7deec8f36 |
