diff --git a/alarmdecoder/decoder.py b/alarmdecoder/decoder.py index 8832ab8..6345c50 100644 --- a/alarmdecoder/decoder.py +++ b/alarmdecoder/decoder.py @@ -20,30 +20,30 @@ class AlarmDecoder(object): """ # High-level Events - on_arm = event.Event('This event is called when the panel is armed.') - on_disarm = event.Event('This event is called when the panel is disarmed.') - on_power_changed = event.Event('This event is called when panel power switches between AC and DC.') - on_alarm = event.Event('This event is called when the alarm is triggered.') - on_fire = event.Event('This event is called when a fire is detected.') - on_bypass = event.Event('This event is called when a zone is bypassed.') - on_boot = event.Event('This event is called when the device finishes booting.') - on_config_received = event.Event('This event is called when the device receives its configuration.') - on_zone_fault = event.Event('This event is called when :py:class:`alarmdecoder.zonetracking.Zonetracker` detects a zone fault.') - on_zone_restore = event.Event('This event is called when :py:class:`alarmdecoder.zonetracking.Zonetracker` detects that a fault is restored.') - on_low_battery = event.Event('This event is called when the device detects a low battery.') - on_panic = event.Event('This event is called when the device detects a panic.') - on_relay_changed = event.Event('This event is called when a relay is opened or closed on an expander board.') + on_arm = event.Event("This event is called when the panel is armed.\n\n**Callback definition:** *def callback(device)*") + on_disarm = event.Event("This event is called when the panel is disarmed.\n\n**Callback definition:** *def callback(device)*") + on_power_changed = event.Event("This event is called when panel power switches between AC and DC.\n\n**Callback definition:** *def callback(device, status)*") + on_alarm = event.Event("This event is called when the alarm is triggered.\n\n**Callback definition:** *def callback(device, status)*") + on_fire = event.Event("This event is called when a fire is detected.\n\n**Callback definition:** *def callback(device, status)*") + on_bypass = event.Event("This event is called when a zone is bypassed. \n\n\n\n**Callback definition:** *def callback(device, status)*") + on_boot = event.Event("This event is called when the device finishes booting.\n\n**Callback definition:** *def callback(device)*") + on_config_received = event.Event("This event is called when the device receives its configuration. \n\n**Callback definition:** *def callback(device)*") + on_zone_fault = event.Event("This event is called when :py:class:`~alarmdecoder.zonetracking.Zonetracker` detects a zone fault.\n\n**Callback definition:** *def callback(device, zone)*") + on_zone_restore = event.Event("This event is called when :py:class:`~alarmdecoder.zonetracking.Zonetracker` detects that a fault is restored.\n\n**Callback definition:** *def callback(device, zone)*") + on_low_battery = event.Event("This event is called when the device detects a low battery.\n\n**Callback definition:** *def callback(device, status)*") + on_panic = event.Event("This event is called when the device detects a panic.\n\n**Callback definition:** *def callback(device, status)*") + on_relay_changed = event.Event("This event is called when a relay is opened or closed on an expander board.\n\n**Callback definition:** *def callback(device, message)*") # Mid-level Events - on_message = event.Event('This event is called when any message is received.') - on_lrr_message = event.Event('This event is called when an :py:class:`alarmdecoder.messages.LRRMessage` is received.') - on_rfx_message = event.Event('This event is called when an :py:class:`alarmdecoder.messages.RFMessage` is received.') + on_message = event.Event("This event is called when any message is received.\n\n**Callback definition:** *def callback(device, message)*") + on_lrr_message = event.Event("This event is called when an :py:class:`~alarmdecoder.messages.LRRMessage` is received.\n\n**Callback definition:** *def callback(device, message)*") + on_rfx_message = event.Event("This event is called when an :py:class:`~alarmdecoder.messages.RFMessage` is received.\n\n**Callback definition:** *def callback(device, message)*") # Low-level Events - on_open = event.Event('This event is called when the device has been opened.') - on_close = event.Event('This event is called when the device has been closed.') - on_read = event.Event('This event is called when a line has been read from the device.') - on_write = event.Event('This event is called when data has been written to the device.') + on_open = event.Event("This event is called when the device has been opened.\n\n**Callback definition:** *def callback(device)*") + on_close = event.Event("This event is called when the device has been closed.\n\n**Callback definition:** *def callback(device)*") + on_read = event.Event("This event is called when a line has been read from the device.\n\n**Callback definition:** *def callback(device, data)*") + on_write = event.Event("This event is called when data has been written to the device.\n\n**Callback definition:** *def callback(device, data)*") # Constants KEY_F1 = unichr(1) + unichr(1) + unichr(1) @@ -291,7 +291,7 @@ class AlarmDecoder(object): :param data: panel data to parse :type data: string - :returns: :py:class:`alarmdecoder.messages.Message` + :returns: :py:class:`~alarmdecoder.messages.Message` """ if data is None: raise InvalidMessageError() @@ -331,7 +331,7 @@ class AlarmDecoder(object): :param data: RF message to parse :type data: string - :returns: :py:class:`alarmdecoder.messages.RFMessage` + :returns: :py:class:`~alarmdecoder.messages.RFMessage` """ msg = RFMessage(data) @@ -346,7 +346,7 @@ class AlarmDecoder(object): :param data: LRR message to parse :type data: string - :returns: :py:class:`alarmdecoder.messages.LRRMessage` + :returns: :py:class:`~alarmdecoder.messages.LRRMessage` """ msg = LRRMessage(data) @@ -395,8 +395,8 @@ class AlarmDecoder(object): """ Updates internal device states. - :param message: :py:class:`alarmdecoder.messages.Message` to update internal states with - :type message: :py:class:`alarmdecoder.messages.Message`, :py:class:`alarmdecoder.messages.ExpanderMessage`, :py:class:`alarmdecoder.messages.LRRMessage`, or :py:class:`alarmdecoder.messages.RFMessage` + :param message: :py:class:`~alarmdecoder.messages.Message` to update internal states with + :type message: :py:class:`~alarmdecoder.messages.Message`, :py:class:`~alarmdecoder.messages.ExpanderMessage`, :py:class:`~alarmdecoder.messages.LRRMessage`, or :py:class:`~alarmdecoder.messages.RFMessage` """ if isinstance(message, Message): self._update_power_status(message) @@ -416,7 +416,7 @@ class AlarmDecoder(object): Uses the provided message to update the AC power state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: bool indicating the new status """ @@ -433,7 +433,7 @@ class AlarmDecoder(object): Uses the provided message to update the alarm state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: bool indicating the new status """ @@ -451,7 +451,7 @@ class AlarmDecoder(object): Uses the provided message to update the zone bypass state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: bool indicating the new status """ @@ -469,7 +469,7 @@ class AlarmDecoder(object): Uses the provided message to update the armed state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: bool indicating the new status """ @@ -491,7 +491,7 @@ class AlarmDecoder(object): Uses the provided message to update the battery state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: boolean indicating the new status """ @@ -511,7 +511,7 @@ class AlarmDecoder(object): Uses the provided message to update the fire alarm state. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.Message` + :type message: :py:class:`~alarmdecoder.messages.Message` :returns: boolean indicating the new status """ @@ -531,7 +531,7 @@ class AlarmDecoder(object): Uses the provided message to update the expander states. :param message: message to use to update - :type message: :py:class:`alarmdecoder.messages.ExpanderMessage` + :type message: :py:class:`~alarmdecoder.messages.ExpanderMessage` :returns: boolean indicating the new status """ @@ -545,10 +545,10 @@ class AlarmDecoder(object): def _update_zone_tracker(self, message): """ - Trigger an update of the :py:class:`alarmdecoder.messages.Zonetracker`. + Trigger an update of the :py:class:`~alarmdecoder.messages.Zonetracker`. :param message: message to update the zonetracker with - :type message: :py:class:`alarmdecoder.messages.Message`, :py:class:`alarmdecoder.messages.ExpanderMessage`, :py:class:`alarmdecoder.messages.LRRMessage`, or :py:class:`alarmdecoder.messages.RFMessage` + :type message: :py:class:`~alarmdecoder.messages.Message`, :py:class:`~alarmdecoder.messages.ExpanderMessage`, :py:class:`~alarmdecoder.messages.LRRMessage`, or :py:class:`~alarmdecoder.messages.RFMessage` """ # Retrieve a list of faults. diff --git a/alarmdecoder/devices.py b/alarmdecoder/devices.py index 50c73e1..4661bab 100644 --- a/alarmdecoder/devices.py +++ b/alarmdecoder/devices.py @@ -35,10 +35,10 @@ class Device(object): """ # Generic device events - on_open = event.Event('This event is called when the device has been opened.') - on_close = event.Event('This event is called when the device has been closed.') - on_read = event.Event('This event is called when a line has been read from the device.') - on_write = event.Event('This event is called when data has been written to the device.') + on_open = event.Event("This event is called when the device has been opened.\n\n**Callback definition:** *def callback(device)*") + on_close = event.Event("This event is called when the device has been closed.\n\n**Callback definition:** def callback(device)*") + on_read = event.Event("This event is called when a line has been read from the device.\n\n**Callback definition:** def callback(device, data)*") + on_write = event.Event("This event is called when data has been written to the device.\n\n**Callback definition:** def callback(device, data)*") def __init__(self): """ @@ -124,7 +124,7 @@ class Device(object): Constructor :param device: device used by the reader thread - :type device: :py:class:`alarmdecoder.devices.Device` + :type device: :py:class:`~alarmdecoder.devices.Device` """ threading.Thread.__init__(self) self._device = device @@ -177,7 +177,7 @@ class USBDevice(Device): Returns all FTDI devices matching our vendor and product IDs. :returns: list of devices - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ cls.__devices = [] @@ -209,7 +209,7 @@ class USBDevice(Device): :type device: tuple :returns: :py:class:`USBDevice` object utilizing the specified device - :raises: :py:class:`alarmdecoder.util.NoDeviceError` + :raises: :py:class:`~alarmdecoder.util.NoDeviceError` """ cls.find_all() @@ -228,9 +228,10 @@ class USBDevice(Device): """ Starts the device detection thread. - :param on_attached: function to be called when a device is attached + :param on_attached: function to be called when a device is attached **Callback definition:** *def callback(thread, device)* :type on_attached: function - :param on_detached: function to be called when a device is detached + :param on_detached: function to be called when a device is detached **Callback definition:** *def callback(thread, device)* + :type on_detached: function """ cls.__detect_thread = USBDevice.DetectThread(on_attached, on_detached) @@ -344,7 +345,7 @@ class USBDevice(Device): reader thread. :type no_reader_thread: bool - :raises: :py:class:`alarmdecoder.util.NoDeviceError` + :raises: :py:class:`~alarmdecoder.util.NoDeviceError` """ # Set up defaults if baudrate is None: @@ -398,7 +399,7 @@ class USBDevice(Device): :param data: data to write :type data: string - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ try: self._device.write_data(data) @@ -413,7 +414,7 @@ class USBDevice(Device): Reads a single character from the device. :returns: character read from the device - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ ret = None @@ -436,7 +437,7 @@ class USBDevice(Device): :type purge_buffer: bool :returns: line that was read - :raises: :py:class:`alarmdecoder.util.CommError`, :py:class:`alarmdecoder.util.TimeoutError` + :raises: :py:class:`~alarmdecoder.util.CommError`, :py:class:`~alarmdecoder.util.TimeoutError` """ def timeout_event(): @@ -496,16 +497,16 @@ class USBDevice(Device): """ Thread that handles detection of added/removed devices. """ - on_attached = event.Event('This event is called when an `AD2USB`_ device has been detected.') - on_detached = event.Event('This event is called when an `AD2USB`_ device has been removed.') + on_attached = event.Event("This event is called when an `AD2USB`_ device has been detected.\n\n**Callback definition:** def callback(thread, device*") + on_detached = event.Event("This event is called when an `AD2USB`_ device has been removed.\n\n**Callback definition:** def callback(thread, device*") def __init__(self, on_attached=None, on_detached=None): """ Constructor - :param on_attached: Function to call when a device is attached + :param on_attached: Function to call when a device is attached **Callback definition:** *def callback(thread, device)* :type on_attached: function - :param on_detached: Function to call when a device is detached + :param on_detached: Function to call when a device is detached **Callback definition:** *def callback(thread, device)* :type on_detached: function """ threading.Thread.__init__(self) @@ -568,7 +569,7 @@ class SerialDevice(Device): :type pattern: string :returns: list of devices - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ devices = [] @@ -626,7 +627,7 @@ class SerialDevice(Device): reader thread. :type no_reader_thread: bool - :raises: :py:class:`alarmdecoder.util.NoDeviceError` + :raises: :py:class:`~alarmdecoder.util.NoDeviceError` """ # Set up the defaults if baudrate is None: @@ -676,7 +677,7 @@ class SerialDevice(Device): :param data: data to write :type data: string - :raises: py:class:`alarmdecoder.util.CommError` + :raises: py:class:`~alarmdecoder.util.CommError` """ try: self._device.write(data) @@ -695,7 +696,7 @@ class SerialDevice(Device): Reads a single character from the device. :returns: character read from the device - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ ret = None @@ -718,7 +719,7 @@ class SerialDevice(Device): :type purge_buffer: bool :returns: line that was read - :raises: :py:class:`alarmdecoder.util.CommError`, :py:class:`alarmdecoder.util.TimeoutError` + :raises: :py:class:`~alarmdecoder.util.CommError`, :py:class:`~alarmdecoder.util.TimeoutError` """ def timeout_event(): @@ -895,7 +896,7 @@ class SocketDevice(Device): thread. :type no_reader_thread: bool - :raises: :py:class:`alarmdecoder.util.NoDeviceError`, :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.NoDeviceError`, :py:class:`~alarmdecoder.util.CommError` """ try: @@ -949,7 +950,7 @@ class SocketDevice(Device): :type data: string :returns: number of bytes sent - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ data_sent = None @@ -971,7 +972,7 @@ class SocketDevice(Device): Reads a single character from the device. :returns: character read from the device - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ data = None @@ -994,7 +995,7 @@ class SocketDevice(Device): :type purge_buffer: bool :returns: line that was read - :raises: :py:class:`alarmdecoder.util.CommError`, :py:class:`alarmdecoder.util.TimeoutError` + :raises: :py:class:`~alarmdecoder.util.CommError`, :py:class:`~alarmdecoder.util.TimeoutError` """ def timeout_event(): @@ -1046,7 +1047,7 @@ class SocketDevice(Device): """ Initializes our device as an SSL connection. - :raises: :py:class:`alarmdecoder.util.CommError` + :raises: :py:class:`~alarmdecoder.util.CommError` """ try: diff --git a/alarmdecoder/messages.py b/alarmdecoder/messages.py index 5a349c5..ceb6e84 100644 --- a/alarmdecoder/messages.py +++ b/alarmdecoder/messages.py @@ -115,7 +115,7 @@ class Message(BaseMessage): :param data: message data :type data: string - :raises: :py:class:`alarmdecoder.util.InvalidMessageError` + :raises: :py:class:`~alarmdecoder.util.InvalidMessageError` """ match = self._regex.match(data) @@ -196,7 +196,7 @@ class ExpanderMessage(BaseMessage): :param data: message data :type data: string - :raises: :py:class:`alarmdecoder.util.InvalidMessageError` + :raises: :py:class:`~alarmdecoder.util.InvalidMessageError` """ try: header, values = data.split(':') @@ -259,7 +259,7 @@ class RFMessage(BaseMessage): :param data: message data :type data: string - :raises: :py:class:`alarmdecoder.util.InvalidMessageError` + :raises: :py:class:`~alarmdecoder.util.InvalidMessageError` """ try: self.raw = data @@ -320,7 +320,7 @@ class LRRMessage(BaseMessage): :param data: message data to parse :type data: string - :raises: :py:class:`alarmdecoder.util.InvalidMessageError` + :raises: :py:class:`~alarmdecoder.util.InvalidMessageError` """ try: self.raw = data diff --git a/alarmdecoder/util.py b/alarmdecoder/util.py index d7cf2ea..2963736 100644 --- a/alarmdecoder/util.py +++ b/alarmdecoder/util.py @@ -62,7 +62,7 @@ class Firmware(object): :param progress_callback: callback function used to report progress :type progress_callback: function - :raises: :py:class:`alarmdecoder.util.NoDeviceError`, :py:class:`alarmdecoder.util.TimeoutError` + :raises: :py:class:`~alarmdecoder.util.NoDeviceError`, :py:class:`~alarmdecoder.util.TimeoutError` """ def do_upload(): diff --git a/alarmdecoder/zonetracking.py b/alarmdecoder/zonetracking.py index 3bf6f8b..798211a 100644 --- a/alarmdecoder/zonetracking.py +++ b/alarmdecoder/zonetracking.py @@ -72,8 +72,8 @@ class Zonetracker(object): Handles tracking of zones and their statuses. """ - on_fault = event.Event('This event is called when the device detects a zone fault.') - on_restore = event.Event('This event is called when the device detects that a fault is restored.') + on_fault = event.Event("This event is called when the device detects a zone fault.\n\n**Callback definition:** *def callback(device, zone)*") + on_restore = event.Event("This event is called when the device detects that a fault is restored.\n\n**Callback definition:** *def callback(device, zone)*") EXPIRE = 30 """Zone expiration timeout.""" @@ -129,7 +129,7 @@ class Zonetracker(object): Update zone statuses based on the current message. :param message: message to use to update the zone tracking - :type message: :py:class:`alarmdecoder.messages.Message` or :py:class:`alarmdecoder.messages.ExpanderMessage` + :type message: :py:class:`~alarmdecoder.messages.Message` or :py:class:`~alarmdecoder.messages.ExpanderMessage` """ if isinstance(message, ExpanderMessage): if message.type == ExpanderMessage.ZONE: diff --git a/docs/build/doctrees/alarmdecoder.doctree b/docs/build/doctrees/alarmdecoder.doctree index 3478f38..1a560fb 100644 Binary files a/docs/build/doctrees/alarmdecoder.doctree and b/docs/build/doctrees/alarmdecoder.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index cfaefb0..6dcbb78 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 044d182..a116e7c 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt index 1cc583f..9304521 100644 --- a/docs/build/html/_sources/index.txt +++ b/docs/build/html/_sources/index.txt @@ -3,17 +3,50 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to alarmdecoder's documentation! +Welcome to Alarm Decoder's documentation! ======================================== -This is the API documentation for the `Alarm Decoder`_ Python library. It provides support for interacting with the `Alarm Decoder`_ (AD2) family of security alarm devices, including the `AD2USB`_, `AD2SERIAL`_ and `AD2PI`_. - -The source code, requirements and examples for this project may be found `here `_. - .. _Alarm Decoder: http://www.alarmdecoder.com .. _AD2USB: http://www.alarmdecoder.com .. _AD2SERIAL: http://www.alarmdecoder.com .. _AD2PI: http://www.alarmdecoder.com +.. _examples: http://github.com/nutechsoftware/alarmdecoder/tree/master/examples + +This is the API documentation for the `Alarm Decoder`_ Python library. It provides support for interacting with the `Alarm Decoder`_ (AD2) family of security alarm devices, including the `AD2USB`_, `AD2SERIAL`_ and `AD2PI`_. + +The source code, requirements and examples for this project may be found `here `_. + +Please see the `examples`_ directory for more samples, but a basic one is included below:: + + import time + from alarmdecoder import AlarmDecoder + from alarmdecoder.devices import USBDevice + + def main(): + """ + Example application that prints messages from the panel to the terminal. + """ + try: + # Retrieve the first USB device + device = AlarmDecoder(USBDevice.find()) + + # Set up an event handler and open the device + device.on_message += handle_message + with device.open(): + while True: + time.sleep(1) + + except Exception, ex: + print 'Exception:', ex + + def handle_message(sender, message): + """ + Handles message events from the AlarmDecoder. + """ + print sender, message.raw + + if __name__ == '__main__': + main() Table of Contents: diff --git a/docs/build/html/alarmdecoder.html b/docs/build/html/alarmdecoder.html index f11d32d..fdf89b4 100644 --- a/docs/build/html/alarmdecoder.html +++ b/docs/build/html/alarmdecoder.html @@ -24,7 +24,7 @@ - +
@@ -37,7 +37,7 @@ modules |
  • - previous |
  • alarmdecoder documentation »
    • @@ -62,120 +62,140 @@
    on_arm

    This event is called when the panel is armed.

    +

    Callback definition: def callback(device)

    on_disarm

    This event is called when the panel is disarmed.

    +

    Callback definition: def callback(device)

    on_power_changed

    This event is called when panel power switches between AC and DC.

    +

    Callback definition: def callback(device, status)

    on_alarm

    This event is called when the alarm is triggered.

    +

    Callback definition: def callback(device, status)

    on_fire

    This event is called when a fire is detected.

    +

    Callback definition: def callback(device, status)

    on_bypass

    This event is called when a zone is bypassed.

    +

    Callback definition: def callback(device, status)

    on_boot

    This event is called when the device finishes booting.

    +

    Callback definition: def callback(device)

    on_config_received

    This event is called when the device receives its configuration.

    +

    Callback definition: def callback(device)

    on_zone_fault
    -

    This event is called when alarmdecoder.zonetracking.Zonetracker detects a zone fault.

    +

    This event is called when Zonetracker detects a zone fault.

    +

    Callback definition: def callback(device, zone)

    on_zone_restore
    -

    This event is called when alarmdecoder.zonetracking.Zonetracker detects that a fault is restored.

    +

    This event is called when Zonetracker detects that a fault is restored.

    +

    Callback definition: def callback(device, zone)

    on_low_battery

    This event is called when the device detects a low battery.

    +

    Callback definition: def callback(device, status)

    on_panic

    This event is called when the device detects a panic.

    +

    Callback definition: def callback(device, status)

    on_relay_changed

    This event is called when a relay is opened or closed on an expander board.

    +

    Callback definition: def callback(device, message)

    on_message

    This event is called when any message is received.

    +

    Callback definition: def callback(device, message)

    on_lrr_message
    -

    This event is called when an alarmdecoder.messages.LRRMessage is received.

    +

    This event is called when an LRRMessage is received.

    +

    Callback definition: def callback(device, message)

    on_rfx_message
    -

    This event is called when an alarmdecoder.messages.RFMessage is received.

    +

    This event is called when an RFMessage is received.

    +

    Callback definition: def callback(device, message)

    on_open

    This event is called when the device has been opened.

    +

    Callback definition: def callback(device)

    on_close

    This event is called when the device has been closed.

    +

    Callback definition: def callback(device)

    on_read

    This event is called when a line has been read from the device.

    +

    Callback definition: def callback(device, data)

    on_write

    This event is called when data has been written to the device.

    +

    Callback definition: def callback(device, data)

    @@ -408,24 +428,28 @@ Also supports SSL if using on_open

    This event is called when the device has been opened.

    +

    Callback definition: def callback(device)

    on_close

    This event is called when the device has been closed.

    +

    Callback definition: def callback(device)*

    on_read

    This event is called when a line has been read from the device.

    +

    Callback definition: def callback(device, data)*

    on_write

    This event is called when data has been written to the device.

    +

    Callback definition: def callback(device, data)*

    @@ -528,7 +552,7 @@ Also supports SSL if using Returns:list of devices -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -562,7 +586,7 @@ by find_all(). Returns:USBDevice object utilizing the specified device -Raises :alarmdecoder.util.NoDeviceError +Raises :NoDeviceError @@ -577,8 +601,8 @@ by find_all(). Parameters:
      -
    • on_attached (function) – function to be called when a device is attached
      • -
    • on_detached (function) – function to be called when a device is detached
      • +
    • on_attached (function) – function to be called when a device is attached Callback definition: def callback(thread, device)
      • +
    • on_detached (function) – function to be called when a device is detached Callback definition: def callback(thread, device)
    @@ -649,7 +673,7 @@ reader thread. -Raises :

    alarmdecoder.util.NoDeviceError

    +Raises :

    NoDeviceError

    @@ -672,7 +696,7 @@ reader thread. Parameters:data (string) – data to write -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -688,7 +712,7 @@ reader thread. Returns:character read from the device -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -712,7 +736,7 @@ reading. Returns:

    line that was read

    -Raises :

    alarmdecoder.util.CommError, alarmdecoder.util.TimeoutError

    +Raises :

    CommError, TimeoutError

    @@ -728,12 +752,14 @@ reading.
    on_attached

    This event is called when an AD2USB device has been detected.

    +

    Callback definition: def callback(thread, device*

    on_detached

    This event is called when an AD2USB device has been removed.

    +

    Callback definition: def callback(thread, device*

    @@ -775,7 +801,7 @@ reading. Returns:list of devices -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -810,7 +836,7 @@ reader thread. -Raises :

    alarmdecoder.util.NoDeviceError

    +Raises :

    NoDeviceError

    @@ -833,7 +859,7 @@ reader thread. Parameters:data (string) – data to write -Raises :py:class:alarmdecoder.util.CommError +Raises :py:class:~alarmdecoder.util.CommError @@ -849,7 +875,7 @@ reader thread. Returns:character read from the device -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -873,7 +899,7 @@ reading. Returns:

    line that was read

    -Raises :

    alarmdecoder.util.CommError, alarmdecoder.util.TimeoutError

    +Raises :

    CommError, TimeoutError

    @@ -974,7 +1000,7 @@ thread. -Raises :

    alarmdecoder.util.NoDeviceError, alarmdecoder.util.CommError

    +Raises :

    NoDeviceError, CommError

    @@ -999,7 +1025,7 @@ thread. Returns:number of bytes sent -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -1015,7 +1041,7 @@ thread. Returns:character read from the device -Raises :alarmdecoder.util.CommError +Raises :CommError @@ -1039,7 +1065,7 @@ reading. Returns:

    line that was read

    -Raises :

    alarmdecoder.util.CommError, alarmdecoder.util.TimeoutError

    +Raises :

    CommError, TimeoutError

    @@ -1383,12 +1409,14 @@ devices.

    on_fault

    This event is called when the device detects a zone fault.

    +

    Callback definition: def callback(device, zone)

    on_restore

    This event is called when the device detects that a fault is restored.

    +

    Callback definition: def callback(device, zone)

    @@ -1433,7 +1461,7 @@ devices.

    -Parameters:message (alarmdecoder.messages.Message or alarmdecoder.messages.ExpanderMessage) – message to use to update the zone tracking +Parameters:message (Message or ExpanderMessage) – message to use to update the zone tracking @@ -1543,7 +1571,7 @@ devices.

    -Raises :

    alarmdecoder.util.NoDeviceError, alarmdecoder.util.TimeoutError

    +Raises :

    NoDeviceError, TimeoutError

    @@ -1580,7 +1608,7 @@ devices.

    Previous topic

    Welcome to alarmdecoder’s documentation!

    + title="previous chapter">Welcome to Alarm Decoder’s documentation!

    This Page

    diff --git a/docs/build/html/index.html b/docs/build/html/index.html index dcf6dd2..f193b6d 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -6,7 +6,7 @@ - Welcome to alarmdecoder’s documentation! — alarmdecoder documentation + Welcome to Alarm Decoder’s documentation! — alarmdecoder documentation @@ -48,10 +48,42 @@
    -
    -

    Welcome to alarmdecoder’s documentation!

    +
    +

    Welcome to Alarm Decoder’s documentation!

    This is the API documentation for the Alarm Decoder Python library. It provides support for interacting with the Alarm Decoder (AD2) family of security alarm devices, including the AD2USB, AD2SERIAL and AD2PI.

    The source code, requirements and examples for this project may be found here.

    +

    Please see the examples directory for more samples, but a basic one is included below:

    +
    import time
+from alarmdecoder import AlarmDecoder
+from alarmdecoder.devices import USBDevice
+
+def main():
+    """
+    Example application that prints messages from the panel to the terminal.
+    """
+    try:
+        # Retrieve the first USB device
+        device = AlarmDecoder(USBDevice.find())
+
+        # Set up an event handler and open the device
+        device.on_message += handle_message
+        with device.open():
+            while True:
+                time.sleep(1)
+
+    except Exception, ex:
+        print 'Exception:', ex
+
+def handle_message(sender, message):
+    """
+    Handles message events from the AlarmDecoder.
+    """
+    print sender, message.raw
+
+if __name__ == '__main__':
+    main()
+
    +

    Table of Contents:

      @@ -84,7 +116,7 @@

      Table Of Contents

        -
      • Welcome to alarmdecoder’s documentation!
          +
        • Welcome to Alarm Decoder’s documentation!
        • Indices and tables
          • diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index f7a8066..3bfc8ad 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 256740f..1b55c85 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{represent:3,all:[0,3],code:[3,2],on_boot:3,stage_don:3,backlight:3,zone:3,messagesexpandermessag:[],readabl:3,send:3,program:3,x03:3,x02:3,x01:3,sent:3,x04:3,sourc:[0,2,3],string:3,clear_zon:3,fals:3,on_messag:3,perimeter_onli:3,lrr:3,level:3,list:3,upload:3,"try":3,emul:3,expandermessag:3,second:3,port:3,supervis:3,ad2seri:[3,2],current:3,"new":0,method:3,ser2sock:3,perimet:3,timeouterror:3,gener:[],usbdevic:3,entry_delay_off:3,here:2,on_config_receiv:3,address:3,path:3,valu:3,fire_alarm:3,search:[3,2],sender:0,prior:3,invalidmessageerror:3,via:3,vid:3,appli:3,filenam:3,api:2,famili:[3,2],from:3,describ:3,commun:3,is_reader_al:3,handler:0,call:[0,3],type:3,relat:3,stage_boot:3,pkei:3,flag:3,indic:[],relai:3,expander_to_zon:3,cach:3,serialdevic:3,must:0,none:[0,3],retriev:3,key_f2:3,on_restor:3,restor:3,dev:3,kwarg:0,can:0,aliv:3,backlight_on:3,process:3,templat:3,high:3,cursor_loc:3,serial:3,occur:3,delai:3,progress_callback:3,secur:2,anoth:3,simulate_wire_problem:3,write:3,purg:3,low:3,instead:0,panic:3,updat:3,product:3,recogn:3,x509:3,ftdi:3,befor:3,attent:3,mai:2,associ:3,github:[],classmethod:3,ssl_ca:3,issu:3,callback:3,"switch":3,ttimeout:3,socketdevic:3,disarm:3,jpath:3,through:3,paramet:3,bypass:3,on_read:3,main:3,"return":3,python:2,timestamp:3,on_bypass:3,detach:3,name:3,revert:3,on_pan:3,authent:3,stage_wait:3,mode:3,timeout:3,found:[3,2],rfx:[],nodeviceerror:3,"static":3,connect:3,our:3,read_lin:3,event:[],ad2pi:[3,2],reboot:3,content:2,reader:3,factori:3,state:3,standard:3,on_clos:3,base:[0,3],dictionari:3,"byte":3,armed_hom:3,on_detach:3,key_f4:3,key_f1:3,thread:3,key_f3:3,emulate_relai:3,openssl:3,readthread:3,get_config:3,on_rfx_messag:3,find_al:3,ad2usb:[3,2],first:3,oper:0,rang:3,number:3,on_writ:3,configbit:3,open:3,on_power_chang:3,differ:3,data:3,interact:2,system:3,wrapper:3,attach:3,start_detect:3,on_open:3,battery_low:3,specifi:3,rfmessag:3,on_fir:3,provid:[3,2],remov:[0,3],charact:3,project:2,str:[],save_config:3,ani:3,bitfield:3,check_zon:3,dedupl:3,expir:3,programming_mod:3,also:[0,3],exampl:2,which:3,event_data:3,channel:3,zone_bypass:3,index:2,pyftdi:3,object:[0,3],most:3,detect:3,basemessag:3,"class":[0,3],armed_awai:3,doc:0,clear:3,request:3,emulate_lrr:3,on_low_batteri:3,text:3,ssl_kei:3,radio:3,find:3,locat:3,configur:3,solut:3,fault_zon:3,should:3,serial_numb:3,stop:3,ssl:3,report:3,requir:[3,2],enabl:3,earg:0,"default":3,common:3,partit:3,contain:3,alarm_event_occur:3,certif:3,set:3,keypad:3,ac_pow:3,displai:3,full:[],arg:0,close:3,arm:3,stop_read:3,pyseri:3,statu:3,wire:3,parent:[],pattern:3,written:3,between:3,progress:3,awai:3,kei:3,numer:3,last:3,fault:3,com:[],batteri:3,on_attach:3,detectthread:3,been:3,beep:3,trigger:3,no_reader_thread:3,fire:[0,3],commerror:3,chime_on:3,convert:3,func:0,present:3,sound:3,raw:3,on_fault:3,cursor:3,defin:0,"while":3,stage_upload:3,error:3,loop:3,readi:3,itself:0,ftdi_vendor_id:3,on_zone_fault:3,alarm_sound:3,panel_data:3,author:3,receiv:3,belong:3,handl:3,decod:[],status:3,finish:3,http:[],expans:3,rais:3,user:3,expand:3,lower:3,entri:3,client:3,thi:[3,2],usual:3,when:3,human:3,baudrat:3,expos:3,on_disarm:3,"_on_open":3,except:3,identif:3,add:0,board:3,match:3,vendor:3,around:3,format:3,read:3,numeric_cod:3,lcd:3,bit:3,ad2:[3,2],like:0,singl:3,page:2,www:[],crypto:3,nutechsoftwar:[],toctre:[],fire_timeout:3,home:3,librari:2,buffer:3,localhost:3,run:3,power:3,event_typ:3,stage_load:3,ssl_certif:3,usb:3,actual:3,simul:3,stage_start:3,address_mask:3,"float":3,automat:3,chime:3,support:[3,2],on_relay_chang:3,"long":3,start:3,interfac:3,includ:2,stop_detect:3,"function":[0,3],tupl:3,eventhandl:0,line:3,emulate_zon:3,whether:3,on_alarm:3,purge_buff:3,alarm:[3,2],"int":3,descript:3,pid:3,repres:3,on_zone_restor:3,exist:0,read_timeout:3,ftdi_product_id:3,check:3,battery_timeout:3,obj:0,boot:3,invalid:3,field:3,bool:3,you:0,intend:3,firmwar:3,track:3,on_arm:3,mask:3,lrrmessag:3,on_lrr_messag:3,maxdepth:[]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:exception","5":"py:classmethod","6":"py:staticmethod"},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","exception","Python exception"],"5":["py","classmethod","Python class method"],"6":["py","staticmethod","Python static method"]},filenames:["alarmdecoder.event","modules","index","alarmdecoder"],titles:["event Package","alarmdecoder","Welcome to alarmdecoder’s documentation!","alarmdecoder Package"],objects:{"alarmdecoder.messages.LRRMessage":{partition:[3,3,1,""],event_data:[3,3,1,""],event_type:[3,3,1,""]},"alarmdecoder.messages.BaseMessage":{raw:[3,3,1,""]},"alarmdecoder.messages.ExpanderMessage":{RELAY:[3,3,1,""],ZONE:[3,3,1,""],value:[3,3,1,""],address:[3,3,1,""],type:[3,3,1,""],channel:[3,3,1,""]},"alarmdecoder.event.event":{EventHandler:[0,1,1,""],Event:[0,1,1,""]},"alarmdecoder.zonetracking.Zone":{status:[3,3,1,""],STATUS:[3,3,1,""],name:[3,3,1,""],zone:[3,3,1,""],timestamp:[3,3,1,""],CLEAR:[3,3,1,""],FAULT:[3,3,1,""],CHECK:[3,3,1,""]},"alarmdecoder.devices.SerialDevice":{read_line:[3,2,1,""],BAUDRATE:[3,3,1,""],read:[3,2,1,""],write:[3,2,1,""],find_all:[3,6,1,""],"interface":[3,3,1,""],close:[3,2,1,""],open:[3,2,1,""]},"alarmdecoder.zonetracking":{Zonetracker:[3,1,1,""],Zone:[3,1,1,""]},"alarmdecoder.zonetracking.Zonetracker":{faulted:[3,3,1,""],on_restore:[3,3,1,""],update:[3,2,1,""],zones:[3,3,1,""],on_fault:[3,3,1,""],EXPIRE:[3,3,1,""],expander_to_zone:[3,2,1,""]},"alarmdecoder.devices.Device.ReadThread":{READ_TIMEOUT:[3,3,1,""],stop:[3,2,1,""],run:[3,2,1,""]},"alarmdecoder.event":{event:[0,0,1,""]},"alarmdecoder.messages":{Message:[3,1,1,""],LRRMessage:[3,1,1,""],RFMessage:[3,1,1,""],ExpanderMessage:[3,1,1,""],BaseMessage:[3,1,1,""]},"alarmdecoder.devices":{Device:[3,1,1,""],SocketDevice:[3,1,1,""],USBDevice:[3,1,1,""],SerialDevice:[3,1,1,""]},"alarmdecoder.devices.USBDevice.DetectThread":{stop:[3,2,1,""],run:[3,2,1,""],on_attached:[3,3,1,""],on_detached:[3,3,1,""]},alarmdecoder:{zonetracking:[3,0,1,""],messages:[3,0,1,""],devices:[3,0,1,""],util:[3,0,1,""],decoder:[3,0,1,""],panels:[3,0,1,""],event:[0,0,1,""]},"alarmdecoder.decoder.AlarmDecoder":{configbits:[3,3,1,""],on_rfx_message:[3,3,1,""],fault_zone:[3,2,1,""],on_open:[3,3,1,""],save_config:[3,2,1,""],on_alarm:[3,3,1,""],on_arm:[3,3,1,""],on_boot:[3,3,1,""],fire_timeout:[3,3,1,""],close:[3,2,1,""],open:[3,2,1,""],id:[3,3,1,""],on_power_changed:[3,3,1,""],BATTERY_TIMEOUT:[3,3,1,""],KEY_F1:[3,3,1,""],KEY_F2:[3,3,1,""],KEY_F3:[3,3,1,""],on_message:[3,3,1,""],reboot:[3,2,1,""],send:[3,2,1,""],on_zone_restore:[3,3,1,""],on_disarm:[3,3,1,""],on_fire:[3,3,1,""],on_write:[3,3,1,""],on_read:[3,3,1,""],on_lrr_message:[3,3,1,""],KEY_F4:[3,3,1,""],clear_zone:[3,2,1,""],on_zone_fault:[3,3,1,""],on_config_received:[3,3,1,""],FIRE_TIMEOUT:[3,3,1,""],on_close:[3,3,1,""],on_bypass:[3,3,1,""],address:[3,3,1,""],battery_timeout:[3,3,1,""],on_panic:[3,3,1,""],on_relay_changed:[3,3,1,""],on_low_battery:[3,3,1,""],emulate_lrr:[3,3,1,""],deduplicate:[3,3,1,""],emulate_zone:[3,3,1,""],get_config:[3,2,1,""],address_mask:[3,3,1,""],emulate_relay:[3,3,1,""]},"alarmdecoder.devices.SocketDevice":{ssl_certificate:[3,3,1,""],ssl_key:[3,3,1,""],read:[3,2,1,""],ssl_ca:[3,3,1,""],read_line:[3,2,1,""],ssl:[3,3,1,""],write:[3,2,1,""],"interface":[3,3,1,""],close:[3,2,1,""],open:[3,2,1,""]},"alarmdecoder.devices.USBDevice":{write:[3,2,1,""],BAUDRATE:[3,3,1,""],description:[3,3,1,""],read:[3,2,1,""],DetectThread:[3,1,1,""],stop_detection:[3,5,1,""],devices:[3,5,1,""],start_detection:[3,5,1,""],read_line:[3,2,1,""],find_all:[3,5,1,""],FTDI_VENDOR_ID:[3,3,1,""],serial_number:[3,3,1,""],"interface":[3,3,1,""],close:[3,2,1,""],FTDI_PRODUCT_ID:[3,3,1,""],open:[3,2,1,""],find:[3,5,1,""]},"alarmdecoder.messages.Message":{backlight_on:[3,3,1,""],alarm_event_occurred:[3,3,1,""],programming_mode:[3,3,1,""],text:[3,3,1,""],bitfield:[3,3,1,""],armed_home:[3,3,1,""],alarm_sounding:[3,3,1,""],ready:[3,3,1,""],zone_bypassed:[3,3,1,""],panel_data:[3,3,1,""],check_zone:[3,3,1,""],numeric_code:[3,3,1,""],battery_low:[3,3,1,""],chime_on:[3,3,1,""],entry_delay_off:[3,3,1,""],perimeter_only:[3,3,1,""],fire_alarm:[3,3,1,""],ac_power:[3,3,1,""],beeps:[3,3,1,""],mask:[3,3,1,""],armed_away:[3,3,1,""],cursor_location:[3,3,1,""]},"alarmdecoder.devices.Device":{stop_reader:[3,2,1,""],on_open:[3,3,1,""],on_write:[3,3,1,""],ReadThread:[3,1,1,""],on_close:[3,3,1,""],on_read:[3,3,1,""],close:[3,2,1,""],is_reader_alive:[3,2,1,""],id:[3,3,1,""]},"alarmdecoder.messages.RFMessage":{battery:[3,3,1,""],value:[3,3,1,""],loop:[3,3,1,""],supervision:[3,3,1,""],serial_number:[3,3,1,""]},"alarmdecoder.decoder":{AlarmDecoder:[3,1,1,""]},"alarmdecoder.event.event.EventHandler":{fire:[0,2,1,""],add:[0,2,1,""],remove:[0,2,1,""]},"alarmdecoder.util.Firmware":{STAGE_LOAD:[3,3,1,""],upload:[3,6,1,""],STAGE_BOOT:[3,3,1,""],STAGE_START:[3,3,1,""],STAGE_UPLOADING:[3,3,1,""],STAGE_WAITING:[3,3,1,""],STAGE_DONE:[3,3,1,""]},"alarmdecoder.util":{CommError:[3,4,1,""],Firmware:[3,1,1,""],TimeoutError:[3,4,1,""],NoDeviceError:[3,4,1,""],InvalidMessageError:[3,4,1,""]}},titleterms:{subpackag:[],alarmdecod:[3,1,2],welcom:2,modul:[0,3],devic:3,zonetrack:3,util:3,packag:[0,3],decod:3,messag:3,indic:2,tabl:2,document:2,event:0,panel:3}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{represent:2,all:[0,2],code:[3,2],sleep:3,on_boot:2,stage_don:2,backlight:2,zone:2,messagesexpandermessag:[],readabl:2,send:2,program:2,x03:2,x02:2,x01:2,sent:2,x04:2,sourc:[0,2,3],string:2,clear_zon:2,fals:2,on_messag:[3,2],perimeter_onli:2,lrr:2,level:2,list:2,upload:2,"try":[3,2],emul:2,expandermessag:2,pleas:3,second:2,port:2,supervis:2,ad2seri:[3,2],current:2,"new":0,method:2,ser2sock:2,full:[],timeouterror:2,gener:[],usbdevic:[3,2],entry_delay_off:2,here:3,on_config_receiv:2,address:2,path:2,valu:2,fire_alarm:2,search:[3,2],sender:[0,3],prior:2,aliv:2,invalidmessageerror:2,via:2,vid:2,appli:2,filenam:2,api:3,famili:[3,2],from:[3,2],describ:2,commun:2,is_reader_al:2,handler:[0,3],call:[0,2],type:2,more:3,relat:2,stage_boot:2,pkei:2,flag:2,indic:[],relai:2,actual:2,cach:2,serialdevic:2,must:0,none:[0,2],retriev:[3,2],thread:2,on_restor:2,restor:2,dev:2,kwarg:0,can:0,def:[3,2],backlight_on:2,process:2,templat:2,high:2,cursor_loc:2,serial:2,occur:2,delai:2,progress_callback:2,secur:3,anoth:2,simulate_wire_problem:2,write:2,purg:2,instead:0,panic:2,updat:2,product:2,recogn:2,x509:2,ftdi:2,befor:2,attent:2,mai:3,data:2,github:[],classmethod:2,ssl_ca:2,issu:2,callback:2,"switch":2,ttimeout:2,socketdevic:2,disarm:2,jpath:2,through:2,paramet:2,bypass:2,on_read:2,main:[3,2],"return":2,python:3,timestamp:2,on_bypass:2,detach:2,name:2,revert:2,on_pan:2,authent:2,stage_wait:2,mode:2,timeout:2,found:[3,2],earg:0,nodeviceerror:2,"static":2,connect:2,our:2,read_lin:2,event:[],ad2pi:[3,2],reboot:2,content:3,reader:2,print:3,factori:2,written:2,standard:2,on_clos:2,base:[0,2],dictionari:2,"byte":2,armed_hom:2,on_detach:2,key_f4:2,key_f1:2,key_f2:2,key_f3:2,emulate_relai:2,openssl:2,readthread:2,get_config:2,on_rfx_messag:2,find_al:2,ad2usb:[3,2],first:[3,2],oper:0,rang:2,number:2,on_writ:2,configbit:2,open:[3,2],on_power_chang:2,differ:2,associ:2,interact:3,system:2,wrapper:2,attach:2,start_detect:2,on_open:2,termin:3,battery_low:2,specifi:2,rfmessag:2,on_fir:2,provid:[3,2],remov:[0,2],charact:2,project:3,str:[],save_config:2,ani:2,bitfield:2,raw:[3,2],on_fault:2,expir:2,"__main__":3,programming_mod:2,also:[0,2],exampl:3,which:2,event_data:2,channel:2,zone_bypass:2,index:3,buffer:2,object:[0,2],most:2,detect:2,basemessag:2,"class":[0,2],armed_awai:2,doc:0,clear:2,request:2,emulate_lrr:2,on_low_batteri:2,text:2,ssl_kei:2,radio:2,find:[3,2],locat:2,configur:2,solut:2,fault_zon:2,should:2,serial_numb:2,stop:2,ssl:2,"import":3,report:2,requir:[3,2],enabl:2,rfx:[],whether:2,common:2,partit:2,contain:2,alarm_event_occur:2,certif:2,set:[3,2],keypad:2,ac_pow:2,on_alarm:2,see:3,perimet:2,arg:0,close:2,arm:2,stop_read:2,pyseri:2,statu:2,wire:2,parent:[],pattern:2,state:2,between:2,progress:2,awai:2,kei:2,numer:2,last:2,fault:2,com:[],batteri:2,identif:2,detectthread:2,been:2,beep:2,trigger:2,basic:3,no_reader_thread:2,fire:[0,2],commerror:2,chime_on:2,convert:2,func:0,present:2,sound:2,check_zon:2,dedupl:2,cursor:2,defin:0,"while":[3,2],stage_upload:2,error:2,loop:2,readi:2,itself:0,ftdi_vendor_id:2,on_zone_fault:2,alarm_sound:2,panel_data:2,author:2,receiv:2,belong:2,handl:[3,2],decod:[],status:2,finish:2,http:[],expans:2,rais:2,user:2,expand:2,lower:2,entri:2,client:2,thi:[3,2],usual:2,boot:2,human:2,baudrat:2,expos:2,field:2,"_on_open":2,except:[3,2],param:[],on_attach:2,add:0,board:2,match:2,applic:3,vendor:2,around:2,format:2,read:2,numeric_cod:2,lcd:2,bit:2,ad2:[3,2],like:0,singl:2,page:3,www:[],crypto:2,nutechsoftwar:[],sampl:3,toctre:[],fire_timeout:2,home:2,librari:3,definit:2,pyftdi:2,localhost:2,run:2,power:2,event_typ:2,stage_load:2,ssl_certif:2,"__name__":3,usb:[3,2],expander_to_zon:2,simul:2,stage_start:2,includ:3,address_mask:2,"float":2,automat:2,chime:2,support:[3,2],on_relay_chang:2,"long":2,start:2,interfac:2,low:2,stop_detect:2,"function":[0,2],tupl:2,eventhandl:0,line:2,"true":3,emulate_zon:2,"default":2,displai:2,purge_buff:2,below:3,alarm:[],"int":2,mask:2,pid:2,repres:2,on_zone_restor:2,exist:0,read_timeout:2,ftdi_product_id:2,check:2,battery_timeout:2,handle_messag:3,when:2,invalid:2,on_disarm:2,bool:2,you:0,maxdepth:[],intend:2,firmwar:2,track:2,on_arm:2,directori:3,descript:2,lrrmessag:2,on_lrr_messag:2,obj:0,time:3},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:exception","5":"py:classmethod","6":"py:staticmethod"},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","exception","Python exception"],"5":["py","classmethod","Python class method"],"6":["py","staticmethod","Python static method"]},filenames:["alarmdecoder.event","modules","alarmdecoder","index"],titles:["event Package","alarmdecoder","alarmdecoder Package","Welcome to Alarm Decoder’s documentation!"],objects:{"alarmdecoder.messages.LRRMessage":{partition:[2,3,1,""],event_data:[2,3,1,""],event_type:[2,3,1,""]},"alarmdecoder.messages.BaseMessage":{raw:[2,3,1,""]},"alarmdecoder.messages.ExpanderMessage":{RELAY:[2,3,1,""],ZONE:[2,3,1,""],value:[2,3,1,""],address:[2,3,1,""],type:[2,3,1,""],channel:[2,3,1,""]},"alarmdecoder.event.event":{EventHandler:[0,1,1,""],Event:[0,1,1,""]},"alarmdecoder.zonetracking.Zone":{status:[2,3,1,""],STATUS:[2,3,1,""],name:[2,3,1,""],zone:[2,3,1,""],timestamp:[2,3,1,""],CLEAR:[2,3,1,""],FAULT:[2,3,1,""],CHECK:[2,3,1,""]},"alarmdecoder.devices.SerialDevice":{read_line:[2,2,1,""],BAUDRATE:[2,3,1,""],read:[2,2,1,""],write:[2,2,1,""],find_all:[2,6,1,""],"interface":[2,3,1,""],close:[2,2,1,""],open:[2,2,1,""]},"alarmdecoder.zonetracking":{Zonetracker:[2,1,1,""],Zone:[2,1,1,""]},"alarmdecoder.zonetracking.Zonetracker":{faulted:[2,3,1,""],on_restore:[2,3,1,""],update:[2,2,1,""],zones:[2,3,1,""],on_fault:[2,3,1,""],EXPIRE:[2,3,1,""],expander_to_zone:[2,2,1,""]},"alarmdecoder.devices.Device.ReadThread":{READ_TIMEOUT:[2,3,1,""],stop:[2,2,1,""],run:[2,2,1,""]},"alarmdecoder.event":{event:[0,0,1,""]},"alarmdecoder.messages":{Message:[2,1,1,""],LRRMessage:[2,1,1,""],RFMessage:[2,1,1,""],ExpanderMessage:[2,1,1,""],BaseMessage:[2,1,1,""]},"alarmdecoder.devices":{Device:[2,1,1,""],SocketDevice:[2,1,1,""],USBDevice:[2,1,1,""],SerialDevice:[2,1,1,""]},"alarmdecoder.devices.USBDevice.DetectThread":{stop:[2,2,1,""],run:[2,2,1,""],on_attached:[2,3,1,""],on_detached:[2,3,1,""]},alarmdecoder:{zonetracking:[2,0,1,""],messages:[2,0,1,""],devices:[2,0,1,""],util:[2,0,1,""],decoder:[2,0,1,""],panels:[2,0,1,""],event:[0,0,1,""]},"alarmdecoder.decoder.AlarmDecoder":{configbits:[2,3,1,""],on_rfx_message:[2,3,1,""],fault_zone:[2,2,1,""],on_open:[2,3,1,""],save_config:[2,2,1,""],on_alarm:[2,3,1,""],on_arm:[2,3,1,""],on_boot:[2,3,1,""],fire_timeout:[2,3,1,""],close:[2,2,1,""],open:[2,2,1,""],id:[2,3,1,""],on_power_changed:[2,3,1,""],BATTERY_TIMEOUT:[2,3,1,""],KEY_F1:[2,3,1,""],KEY_F2:[2,3,1,""],KEY_F3:[2,3,1,""],on_message:[2,3,1,""],reboot:[2,2,1,""],send:[2,2,1,""],on_zone_restore:[2,3,1,""],on_disarm:[2,3,1,""],on_fire:[2,3,1,""],on_write:[2,3,1,""],on_read:[2,3,1,""],on_lrr_message:[2,3,1,""],KEY_F4:[2,3,1,""],clear_zone:[2,2,1,""],on_zone_fault:[2,3,1,""],on_config_received:[2,3,1,""],FIRE_TIMEOUT:[2,3,1,""],on_close:[2,3,1,""],on_bypass:[2,3,1,""],address:[2,3,1,""],battery_timeout:[2,3,1,""],on_panic:[2,3,1,""],on_relay_changed:[2,3,1,""],on_low_battery:[2,3,1,""],emulate_lrr:[2,3,1,""],deduplicate:[2,3,1,""],emulate_zone:[2,3,1,""],get_config:[2,2,1,""],address_mask:[2,3,1,""],emulate_relay:[2,3,1,""]},"alarmdecoder.devices.SocketDevice":{ssl_certificate:[2,3,1,""],ssl_key:[2,3,1,""],read:[2,2,1,""],ssl_ca:[2,3,1,""],read_line:[2,2,1,""],ssl:[2,3,1,""],write:[2,2,1,""],"interface":[2,3,1,""],close:[2,2,1,""],open:[2,2,1,""]},"alarmdecoder.devices.USBDevice":{write:[2,2,1,""],BAUDRATE:[2,3,1,""],description:[2,3,1,""],read:[2,2,1,""],DetectThread:[2,1,1,""],stop_detection:[2,5,1,""],devices:[2,5,1,""],start_detection:[2,5,1,""],read_line:[2,2,1,""],find_all:[2,5,1,""],FTDI_VENDOR_ID:[2,3,1,""],serial_number:[2,3,1,""],"interface":[2,3,1,""],close:[2,2,1,""],FTDI_PRODUCT_ID:[2,3,1,""],open:[2,2,1,""],find:[2,5,1,""]},"alarmdecoder.messages.Message":{backlight_on:[2,3,1,""],alarm_event_occurred:[2,3,1,""],programming_mode:[2,3,1,""],text:[2,3,1,""],bitfield:[2,3,1,""],armed_home:[2,3,1,""],alarm_sounding:[2,3,1,""],ready:[2,3,1,""],zone_bypassed:[2,3,1,""],panel_data:[2,3,1,""],check_zone:[2,3,1,""],numeric_code:[2,3,1,""],battery_low:[2,3,1,""],chime_on:[2,3,1,""],entry_delay_off:[2,3,1,""],perimeter_only:[2,3,1,""],fire_alarm:[2,3,1,""],ac_power:[2,3,1,""],beeps:[2,3,1,""],mask:[2,3,1,""],armed_away:[2,3,1,""],cursor_location:[2,3,1,""]},"alarmdecoder.devices.Device":{stop_reader:[2,2,1,""],on_open:[2,3,1,""],on_write:[2,3,1,""],ReadThread:[2,1,1,""],on_close:[2,3,1,""],on_read:[2,3,1,""],close:[2,2,1,""],is_reader_alive:[2,2,1,""],id:[2,3,1,""]},"alarmdecoder.messages.RFMessage":{battery:[2,3,1,""],value:[2,3,1,""],loop:[2,3,1,""],supervision:[2,3,1,""],serial_number:[2,3,1,""]},"alarmdecoder.decoder":{AlarmDecoder:[2,1,1,""]},"alarmdecoder.event.event.EventHandler":{fire:[0,2,1,""],add:[0,2,1,""],remove:[0,2,1,""]},"alarmdecoder.util.Firmware":{STAGE_LOAD:[2,3,1,""],upload:[2,6,1,""],STAGE_BOOT:[2,3,1,""],STAGE_START:[2,3,1,""],STAGE_UPLOADING:[2,3,1,""],STAGE_WAITING:[2,3,1,""],STAGE_DONE:[2,3,1,""]},"alarmdecoder.util":{CommError:[2,4,1,""],Firmware:[2,1,1,""],TimeoutError:[2,4,1,""],NoDeviceError:[2,4,1,""],InvalidMessageError:[2,4,1,""]}},titleterms:{subpackag:[],alarmdecod:[2,1],welcom:3,alarm:3,devic:2,zonetrack:2,event:0,util:2,packag:[0,2],decod:[3,2],messag:2,indic:3,tabl:3,document:3,modul:[0,2],panel:2}}) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 1cc583f..9304521 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,17 +3,50 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to alarmdecoder's documentation! +Welcome to Alarm Decoder's documentation! ======================================== -This is the API documentation for the `Alarm Decoder`_ Python library. It provides support for interacting with the `Alarm Decoder`_ (AD2) family of security alarm devices, including the `AD2USB`_, `AD2SERIAL`_ and `AD2PI`_. - -The source code, requirements and examples for this project may be found `here `_. - .. _Alarm Decoder: http://www.alarmdecoder.com .. _AD2USB: http://www.alarmdecoder.com .. _AD2SERIAL: http://www.alarmdecoder.com .. _AD2PI: http://www.alarmdecoder.com +.. _examples: http://github.com/nutechsoftware/alarmdecoder/tree/master/examples + +This is the API documentation for the `Alarm Decoder`_ Python library. It provides support for interacting with the `Alarm Decoder`_ (AD2) family of security alarm devices, including the `AD2USB`_, `AD2SERIAL`_ and `AD2PI`_. + +The source code, requirements and examples for this project may be found `here `_. + +Please see the `examples`_ directory for more samples, but a basic one is included below:: + + import time + from alarmdecoder import AlarmDecoder + from alarmdecoder.devices import USBDevice + + def main(): + """ + Example application that prints messages from the panel to the terminal. + """ + try: + # Retrieve the first USB device + device = AlarmDecoder(USBDevice.find()) + + # Set up an event handler and open the device + device.on_message += handle_message + with device.open(): + while True: + time.sleep(1) + + except Exception, ex: + print 'Exception:', ex + + def handle_message(sender, message): + """ + Handles message events from the AlarmDecoder. + """ + print sender, message.raw + + if __name__ == '__main__': + main() Table of Contents: