Metadata-Version: 2.1
Name: pyspcwebgw
Version: 0.5.0
Summary: A Python library for communicating with SPC Web Gateway.
Home-page: https://github.com/mbrrg/pyspcwebgw
Author: Martin Berg
Author-email: mbrrg@users.noreply.github.com
License: MIT
Download-URL: https://github.com/mbrrg/pyspcwebgw/archive/0.5.0.zip
Description: 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 <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.
        - ```debug```. Toggle debug output.
        
Keywords: spc,vanderbilt,web gateway
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Home Automation
Requires-Python: >=3.6
Description-Content-Type: text/markdown
