Implementation examples

Protocols

Nexa

class protocols.nexa.Nexa(kernel)

Main class of a protocol plugin.

add_device(device_id, args)

Proxy method used to instantiate a new device. It raises a ValueError if the device_id given is out of range. It may raise a TypeError if the args given to set the new device don’t match the settings format.

decode_sequence(sequence)

Processes a radio sequence received by the radio modem into a message understable by the protocol. The implementation of the sequence processing is , for the moment, a hard-coded finite-state machine.

get_devices()

Returns the list of devices that are currently handled by this protocol.

get_instantiable_devices()

Returns a list of the devices instantiable by the user of the driver. The list of user-instantiable devices is included in the list of the driver-handled devices but not necessarily equal.

get_set_arguments()

Returns the arguments needed to set the driver.

send_command(device, command)

Method called when a device intends to send a message. It builds up the Nexa message according to the command to be sent and the identity of the sending device.

set(args)

Sets the driver. It raises a TypeError if the given modem doesn’t match the awaited modem type.

Keyword arguments: settings – the dictionary of settings used to set the driver. Its format is determined by the function get_set_arguments.

Oregon

class protocols.oregon.Oregon(kernel)

Main class of a protocol plugin.

add_device(device_id, args)

Proxy method used to instantiate a new device. It raises a ValueError if the device_id given is out of range. It may raise a TypeError if the args given to set the new device don’t match the settings format.

decode_sequence(radio_sequence)

Processes a radio sequence received by the radio modem into a message understable by the protocol. The implementation of the sequence processing is , for the moment, a hard-coded finite-state machine.

get_devices()

Returns the list of devices that are currently handled by this protocol.

get_instantiable_devices()

Returns a list of the devices instantiable by the user of the driver. The list of user-instantiable devices is included in the list of the driver-handled devices but not necessarily equal.

get_set_arguments()

Returns the arguments needed to set the driver.

send_command(device, command)

Method called when a device intends to send a message. It builds up the Nexa message according to the command to be sent and the identity of the sending device.

set(args)

Sets the driver. It raises a TypeError if the given modem doesn’t match the awaited modem type.

Keyword arguments: settings – the dictionary of settings used to set the driver. Its format is determined by the function get_set_arguments.

Drivers

Arduino as a 433MHz AM transceiver

class drivers.arduino_radio.ArduinoRadio

Class implementing the interface between the computer running the domotic box and the Arduino, which is used as a 433MHz radio modem.

attach(observer)

Adds the protocol object given as argument to the list of protocols that receive their messages through this modem. When the modem receives a radio sequence, it will send it to the whole list of its observers.

format_arg(binary)

Formats a binary sequence so that it fits the format of the parameters of a command sent to the Arduino. This method is called by the send_sequence method.

get_modem_name()

Returns the name of the modem.

get_modem_type()

Returns the type of the modem.

get_set_arguments()

Returns the dictionary of arguments that have to be used in order to set this module.

notify_observers(sequence)

Notifies all the protocols that are observing this modem that an incoming radio message has arrived. The received sequence is given as argument so that each protocol can handle the decoding.

send_sequence(sequence)

Sends the radio sequence given as an argument.

The sequence dictionary must have the following format :

Key	Type
number_of_repetitions	int
base_radio_pulse_length_in_microseconds	int
symbol_1	binary_string
symbol_2	binary_string
...	binary_string
symbol_n	binary_string
symbol_coded_message	symbols_list

set(args)

Sets the serial communication used by the domotic box to communicate with the Arduino. If the given COM port number is not valid (i.e. it raises a SerialException when we try to open the connection) the method raises the same serial.SerialException.