| @@ -15,30 +15,37 @@ AlarmDecoder | |||||
| Summary | Summary | ||||
| ------- | ------- | ||||
| This Python library aims to provide a consistent interface for the `AlarmDecoder`_ product line. (AD2USB, AD2SERIAL and AD2PI) | |||||
| This Python library aims to provide a consistent interface for the | |||||
| `AlarmDecoder`_ product line. (AD2USB, AD2SERIAL and AD2PI). | |||||
| This also includes devices that have been exposed via `ser2sock`_, which | This also includes devices that have been exposed via `ser2sock`_, which | ||||
| supports encryption via SSL/TLS. | supports encryption via SSL/TLS. | ||||
| ------------ | ------------ | ||||
| Installation | Installation | ||||
| ------------ | ------------ | ||||
| AlarmDecoder can be installed through pip: | |||||
| AlarmDecoder can be installed through ``pip``: | |||||
| pip install alarmdecoder | pip install alarmdecoder | ||||
| or from source: | or from source: | ||||
| python setup.py install | python setup.py install | ||||
| * Note: python-setuptools is required for installation. | |||||
| * Note: ``python-setuptools`` is required for installation. | |||||
| ------------ | ------------ | ||||
| Requirements | Requirements | ||||
| ------------ | ------------ | ||||
| Required: | Required: | ||||
| * An `AlarmDecoder`_ device | * An `AlarmDecoder`_ device | ||||
| * Python 2.7 | * Python 2.7 | ||||
| * `pyserial`_ >= 2.7 | * `pyserial`_ >= 2.7 | ||||
| Optional: | Optional: | ||||
| * `pyftdi`_ >= 0.9.0 | * `pyftdi`_ >= 0.9.0 | ||||
| * `pyusb`_ >= 1.0.0b1 | * `pyusb`_ >= 1.0.0b1 | ||||
| * `pyopenssl`_ | * `pyopenssl`_ | ||||
| @@ -46,12 +53,15 @@ Optional: | |||||
| ------------- | ------------- | ||||
| Documentation | Documentation | ||||
| ------------- | ------------- | ||||
| API documentation can be found at `readthedocs`_. | API documentation can be found at `readthedocs`_. | ||||
| -------- | -------- | ||||
| Examples | Examples | ||||
| -------- | -------- | ||||
| A basic example is included below. Please see the `examples`_ directory for more.:: | |||||
| A basic example is included below. Please see the `examples`_ directory for | |||||
| more.:: | |||||
| import time | import time | ||||
| from alarmdecoder import AlarmDecoder | from alarmdecoder import AlarmDecoder | ||||