Skip to main content

A Python module to interact with SCSGate

Project description

This python module allows to interact with a SCSGate device.

The module has been written to manage a SCSGate device with home-assistant.

Installation

The scsgate module can be installed using pip:

sudo pip install scsgate

Monitoring the SCS bus

The scsgate pip package provides a script named scs-monitor that has two purposes:

  • interactively create a configuration file for home-assistant

  • sniff all the messages going over the SCS bus

Creation of a home-assistant configuration file

scs-monitor can be used to create a home-assistant configuration file defining all the available devices.

This can be done by using the --homeassistant-config flag.

Once started scs-monitor will start sniffing all the events going over the SCS bus. For each captured message it will extract the ID of the relevant device and will ask the user to enter an ID for home-assistant and the name of the device.

By pressing CTRL-C the program will exit and generate the home-assistant configuration file.

Sniffing messages

By defaul scs-monitor will print all the messages going over the SCS buffer.

It’s possible to filter the messages related with a list of known devices. This can be done using the -f flag followed by the name of the file containing the devices to ignore. The file is a yaml document like the one created in the previous step.

It’s also possible to redirect all the output to a text file by using the -o flag.

License

This code is licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scsgate-0.1.0.tar.gz (8.4 kB view details)

Uploaded Source

File details

Details for the file scsgate-0.1.0.tar.gz.

File metadata

  • Download URL: scsgate-0.1.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for scsgate-0.1.0.tar.gz
Algorithm Hash digest
SHA256 70cbd27d74bae3135efa0d3a27f6ede3a45e83359f67577c4a144c220de69f26
MD5 71e18345c7974c615c8b7e9009e27eb1
BLAKE2b-256 55c905c8eaae6ca0145bf0462e2716ca63834702c0390660bc42b38c0a4fdc17

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page