janitoo package¶

Submodules¶

janitoo.bus module¶

The bus

A physical or logical bus : i2c, 1-wire, thermal, ...

class janitoo.bus.JNTBus(oid='generic', **kwargs)[source]¶

Bases: object

A bus holds components A bus is mapped in a controller node

A master bus can aggregate multiple bus to hold different compenents on the same bus.

Look at janitoo_raspberry_fishtank, janitoo_lapinoo, ...

A bus can be extended to add new features, shared resource, ...

Look at janitoo_raspberry_spi, janitoo_raspberry_i2c and janitoo_raspberry_i2c_pca9865, janitoo_events and janitoo_events_cron, ...

add_component(oid, addr, **kwargs)[source]¶: Add a component on the bus

cant_aggregate(oid)[source]¶

check_heartbeat()[source]¶: Check that the bus is ‘available’. Is replaced by the node one when it’s creates

clean_attrs(objname)[source]¶: Clean exported object from all targets

create_node(nodeman, hadd, **kwargs)[source]¶: Create a node associated to this bus

export_attrs(objname, obj)[source]¶: Export object to all targets

export_values()[source]¶: Export values to all targets

extend_from_entry_points(oid, eps=None)[source]¶: “Extend the bus with methods found in entrypoints

find_components(component_oid)[source]¶: Find components using an oid

find_values(component_oid, value_uuid)[source]¶: Find a value using its uuid and the component oid

get_bus_value(value_uuid, oid=None)[source]¶: Retrieve a bus’s private value. Take care of exported buses This is the preferred way to retrieve a value of the bus

kernel_modprobe(module, params='')[source]¶

Load a kernel module. Needs to be root (raspberry)

Parameters:	module (str) – the kernel module to load params (str) – module parameters

kernel_rmmod(module)[source]¶

Remove a kernel module. Needs to be root (raspberry)

Parameters:	module (str) – the kernel module to remove

load_extensions(oid)[source]¶: “Load extensions from config file.

loop(stopevent)[source]¶: Loop Don’t do long task in loop. Use a separated thread to not perturbate the nodeman

name = None¶: The name

options = None¶: The options

product_name = None¶: The product name of the node

product_type = None¶: The product type of the node

start(mqttc, trigger_thread_reload_cb=None)[source]¶: Start the bus Components will be started by the nodemanager after retrieving configuration.

stop()[source]¶: Stop the bus and components

update_attrs(objname, obj)[source]¶: Update object to all targets

uuid[source]¶: Return an uuid for the bus. Must be the same as the section name to retrieve the hadd of the controller

janitoo.classes module¶

The classes

Largely inspired from https://github.com/OpenZWave/open-zwave/tree/master/cpp/src/command_classes

The capabilites of the nodes or the controller

janitoo.component module¶

The component

An I2C device, ...

class janitoo.component.JNTComponent(oid='generic.generic', bus=None, addr=None, **kwargs)[source]¶

Bases: object

check_heartbeat()[source]¶: Check that the component is ‘available’

create_node(hadd, **kwargs)[source]¶: Create a node associated to this component

get_bus_value(value_uuid, oid=None)[source]¶: Retrieve a bus’s private value. Take care of exported buses This is the preferred way to retrieve a value of the bus

get_package_name()[source]¶

Return the name of the package. Needed to publish static files

MUST be copy paste in every extension that publish statics files

loop(stopevent)[source]¶

resource_filename(path='public')[source]¶: Needed to publish static files

start(mqttc)[source]¶: Start the component. Can be used to start a thread to acquire data.

stop()[source]¶: Stop the component.

uuid[source]¶: Return an uuid for the component

janitoo.dhcp module¶

The dhcp library

TODO : - actuellement l’etat HEARTBEAT n’existe que pour les primary car il sert pour le discover. - il faut l’implémenter pour les secondary : par /resolv ? /dhcp/?

class janitoo.dhcp.CacheManager[source]¶

Bases: object

check_heartbeats(heartbeat_timeout=60, heartbeat_count=3, heartbeat_dead=604800)[source]¶

Check the states of the machine. Must be called in a timer Called in a separate thread. Must use a scoped_session.

Parameters:	session (sqlalchemy session) – the session to use to communicate with db. May be a scoped_session if used in a separate tread. If None, use the common session.

flush(query=None)[source]¶

Flush the cache to db. Remmove failed name from cache

Parameters:	session (sqlalchemy session) – the session to use to communicate with db. May be a scoped_session if used in a separate tread. If None, use the common session.

get_state(add_ctrl, add_node)[source]¶

Return the state of an entry in cache

Parameters:	add_ctrl (Integer) – the controller part of the address add_node (Integer) – the node part of the address. 0 for controller, -1 for all nodes managed by controller.

has_entry(add_ctrl, add_node)[source]¶

Chech if an entry is in cache

Parameters:	add_ctrl (Integer) – the controller part of the address add_node (Integer) – the node part of the address. 0 for controller, -1 for all nodes managed by controller.

len()[source]¶: Number of entries in the cache

remove(add_ctrl, add_node)[source]¶

Remove an entry fom cache

Parameters:	add_ctrl (Integer) – the controller part of the address add_node (Integer) – the node part of the address. 0 for controller, -1 for all nodes managed by controller.

start(query)[source]¶: Load the cache from db

update(add_ctrl, add_node, state='ONLINE', heartbeat=30, last_seen=None)[source]¶

Update an entry in cache

Parameters:	add_ctrl (Integer) – the controller part of the address add_node (Integer) – the node part of the address. 0 for controller, -1 for all nodes managed by controller. state (String) – the state of the node. last_seen (datetime) – the last time the node have been seen.

class janitoo.dhcp.HeartbeatMessage(message)[source]¶

Bases: object

get_heartbeat()[source]¶

class janitoo.dhcp.JNTNetwork(stopevent, options, **kwargs)[source]¶

Bases: object

The network manager : handle all nodes, values, ...

Will be used in dhcp server and web server.

Should work in 2 modes :

resolv : use the dhcp to retrieve information : nodes, values, configs, ...

listen to nodes updates sent by the dhcp (node_update, node_added, node_remove, ...

broadcast : to retrieve informations from nodes : in case of a dhcp fail or for the dhcp itself

heartbeat listening : when we receive a heartbeat from an unknown node, we send it standard system queries

send notification for node_added, node_update_info, node_update_config, ...

Actually, we depend on socket/flask to emit update for the listener. This should be removed for the merge with the dhcp manager We can achieve it by callbacks or class heritage.

Same problem for the lease manager

heartbeat : heartbeat will be managed inside this class. No more dependcy to /dhcp = > new topic /heartbeat

Starting as master is simple

We should implement startup as a state machine : master : broadcast -> heartbeat secondary : resolv and if needed -> failover

State machines :

fsm_network : a global one to manage primary, secondary and fail over states

add_basics(data)[source]¶

add_commands(data)[source]¶

add_configs(data)[source]¶

add_nodes(data)[source]¶

add_systems(data)[source]¶

add_users(data)[source]¶

basics_count[source]¶

Return type:	int

before_stop_fsm()[source]¶: Stop the network

boot(hadds, loop_sleep=0.1)[source]¶: Boot the node manager

clean_all()[source]¶: Delete the fsm

commands_count[source]¶

Return type:	int

configs_count[source]¶

Return type:	int

create_fsm()[source]¶

delete_fsm()[source]¶: Delete the fsm

emit_all()[source]¶: Emit all events nodes : a single node or a dict of nodes

emit_basic(basics)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_basics()[source]¶: Emit a nodes state event

emit_command(systems)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_commands()[source]¶: Emit a nodes state event

emit_config(configs)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_configs()[source]¶: Emit a nodes state event

emit_cron(cron)[source]¶: Emit a cron state event nodes : a single cron or a dict of cron

emit_crons()[source]¶: Emit a cron state event

emit_network()[source]¶: Emit a network state event

emit_node(nodes)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_nodes()[source]¶: Emit a nodes state event

emit_scenario(scenario)[source]¶: Emit a scenario state event nodes : a single scenario or a dict of scenario

emit_scenarios()[source]¶: Emit a scenario state event

emit_scene(scene)[source]¶: Emit a scene state event nodes : a single scene or a dict of scene

emit_scenes()[source]¶: Emit a scene state event

emit_system(systems)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_systems()[source]¶: Emit a nodes state event

emit_user(users)[source]¶: Emit a node state event nodes : a single node or a dict of nodes

emit_users()[source]¶: Emit a nodes state event

find_controller_nodes(add_ctrl)[source]¶: Retrieve nodes of a controller

find_controllers()[source]¶: Retrieve controller nodes on the network

find_neighbors(node_hadd)[source]¶

Retrieve neighbors of a node on the network :

All controllers are neighbors of the network controllers A controller has all the nodes it holds as neighbors A simple node has only one neighbor : its controller

find_network_controllers()[source]¶: Retrieve network controller nodes on the network

find_node_value(node_hadd, genre='systems', vuuid=None)[source]¶: Retrieve value of a node on the network :

find_node_values(node_hadd, genre='systems')[source]¶: Retrieve values of a node on the network :

find_primary_controllers()[source]¶: Retrieve primaries nodes on the network

find_secondary_controllers()[source]¶: Retrieve secondaries nodes on the network

finish_broadcast_basics_discover()[source]¶

finish_broadcast_commands_discover()[source]¶

finish_broadcast_configs_discover()[source]¶

finish_broadcast_nodes_discover()[source]¶

finish_broadcast_systems_discover()[source]¶

finish_broadcast_users_discover()[source]¶

finish_dispatch_heartbeat_timer()[source]¶: This function is called when we did nod receive informations on /dhcp/resolv defore timeout. The dhcp server must have send its ‘online’ status ... so he his dead fallback to fail mode

finish_resolv_discover()[source]¶: This function is called when we did nod receive informations on /dhcp/resolv defore timeout. The dhcp server must have send its ‘online’ status ... so he his dead fallback to fail mode

finish_resolv_heartbeat_timer()[source]¶: This function is called when we did nod receive informations on /dhcp/resolv defore timeout. The dhcp server must have send its ‘online’ status ... so he his dead fallback to fail mode

from_dict(adict)[source]¶: Update internal dict from adict

fsm_do_heartbeat_dispatch()[source]¶

fsm_is_primary()[source]¶

fsm_is_secondary()[source]¶

fsm_network_states = [<transitions.core.State object at 0x2b74cb2efdd0>, <transitions.core.State object at 0x2b74cb2efe90>, <transitions.core.State object at 0x2b74cb2efed0>, <transitions.core.State object at 0x2b74cb2eff10>, <transitions.core.State object at 0x2b74cb2eff50>, <transitions.core.State object at 0x2b74cb2eff90>, <transitions.core.State object at 0x2b74cb2effd0>, <transitions.core.State object at 0x2b74cb2ff050>, <transitions.core.State object at 0x2b74cb2ff090>, <transitions.core.State object at 0x2b74cb2ff0d0>, <transitions.core.State object at 0x2b74cb2ff110>, <transitions.core.State object at 0x2b74cb2ff150>]¶

fsm_on_started()[source]¶

get_crons()[source]¶: Retrieves crons on the network

get_scenarios()[source]¶: Retrieves scenarios on the network

get_scenes()[source]¶: Retrieves scenes on the network

incoming_hearbeat(add_ctrl, add_node, state)[source]¶

is_failed[source]¶

is_started[source]¶: Return True if the network is started

is_stopped[source]¶: Return True if the network is stopped

kvals[source]¶

The keyvals store in db for this object.

Return type:	{}

nodes_count[source]¶

Return type:	int

nodes_to_dict(nodes)[source]¶: nodes to dict

on_heartbeat(client, userdata, message)[source]¶

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_heartbeat_discover(client, userdata, message)[source]¶

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_reply(client, userdata, message)[source]¶

On reply

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_resolv_heartbeat(client, userdata, message)[source]¶

On resolv

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_resolv_reply(client, userdata, message)[source]¶

On resolv

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_resolv_request(client, userdata, message)[source]¶

On diqpatch request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_value(client, userdata, message)[source]¶

On value

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

request_node_basics(hadd)[source]¶

request_node_commands(hadd)[source]¶

request_node_configs(hadd)[source]¶

request_node_nodes(hadd)[source]¶

request_node_systems(hadd)[source]¶

request_node_users(hadd)[source]¶

request_resolv_basics()[source]¶

request_resolv_commands()[source]¶

request_resolv_configs()[source]¶

request_resolv_nodes()[source]¶

request_resolv_systems()[source]¶

request_resolv_users()[source]¶

set_failed()[source]¶

start(loop_sleep=0.1)[source]¶: Start the network

start_broadcast_basics_discover()[source]¶

start_broadcast_commands_discover()[source]¶

start_broadcast_configs_discover()[source]¶

start_broadcast_nodes_discover()[source]¶

start_broadcast_systems_discover()[source]¶

start_broadcast_users_discover()[source]¶

start_dispatch_heartbeat()[source]¶

start_dispatch_heartbeat_timer()[source]¶

start_heartbeat()[source]¶

start_heartbeat_discover()[source]¶

start_nodes_discover()[source]¶

start_resolv_discover()[source]¶

start_resolv_heartbeat()[source]¶

start_resolv_heartbeat_timer()[source]¶

start_resolv_request()[source]¶

start_values_listener()[source]¶

state_str[source]¶

Return type:	str

state_to_dict()[source]¶: state to dict

states_str = {'BROADCAST_NODES': 'Broadcasting nodes', 'BROADCAST_BASICS': 'Broadcasting basic values', 'DISPATCH': 'Start headbeart dispatch', 'BROADCAST_USERS': 'Broadcasting user values', 'STOPPED': 'Network is stopped', 'BROADCAST_SYSTEMS': 'Broadcasting system values', 'HEARTBEAT': 'Start headbeart listening', 'HEARTBEAT_DISCOVER': 'Start headbeart discovering', 'BROADCAST_COMMANDS': 'Broadcasting command values', 'BROADCAST_CONFIGS': 'Broadcasting config values', 'RESOLV': 'Resolving nodes', 'STARTED': 'Network is started'}¶: The states of the network

stop()[source]¶: Stop the network

stop_broadcast_basics_discover()[source]¶

stop_broadcast_commands_discover()[source]¶

stop_broadcast_configs_discover()[source]¶

stop_broadcast_discover()[source]¶

stop_broadcast_nodes_discover()[source]¶

stop_broadcast_systems_discover()[source]¶

stop_broadcast_users_discover()[source]¶

stop_dispatch_heartbeat()[source]¶

stop_dispatch_heartbeat_timer()[source]¶

stop_heartbeat()[source]¶

stop_heartbeat_discover()[source]¶

stop_nodes_discover()[source]¶

stop_resolv_discover()[source]¶

stop_resolv_heartbeat()[source]¶

stop_resolv_heartbeat_timer()[source]¶

stop_resolv_request()[source]¶

stop_values_listener()[source]¶

systems_count[source]¶

Return type:	int

to_dict(which='state')[source]¶: Create a dict of which : state, nodes, configs, ...

unset_failed()[source]¶

users_count[source]¶

Return type:	int

janitoo.dhcp.check_heartbeats(entries, heartbeat_timeout=60, heartbeat_count=3, heartbeat_dead=604800)[source]¶

Check the states of the machine. Must be called in a timer Called in a separate thread. Must use a scoped_session.

Parameters:	session (sqlalchemy session) – the session to use to communicate with db. May be a scoped_session if used in a separate tread. If None, use the common session.

janitoo.dhcp.normalize_request_info_nodes(data)[source]¶

janitoo.dhcp.normalize_request_info_values(data)[source]¶

janitoo.dhcp.normalize_request_system_values(data)[source]¶

janitoo.dhcp.threaded_send_resolv(thread_event, options, hadd, resp, data)[source]¶

janitoo.fsm module¶

The FSM

janitoo.fsm.show_graph(self, fname='state.png', prog='dot', title=None)[source]¶

janitoo.mqtt module¶

The mqtt client

Largely inspired from http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.python.git/tree/examples/sub-class.py

class janitoo.mqtt.MQTTBasic(options=None, **kwargs)[source]¶

Bases: paho.mqtt.client.Client

A grandmother for mqtt

connect_with_options()[source]¶

Connect to the mqtt broker using options

returns :: 0: Connection successful 1: Connection refused - incorrect protocol version 2: Connection refused - invalid client identifier 3: Connection refused - server unavailable 4: Connection refused - bad username or password 5: Connection refused - not authorised 6-255: Currently unused.

disconnect()[source]¶

publish_heartbeat(add_ctrl, add_node, state='ONLINE', qos=0, retain=False)[source]¶

Publish an heartbeat for the node add_ctrl, add_node.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_controller(add_ctrl, state='ONLINE', qos=0, retain=False)[source]¶

Publish an heartbeat for the controller add_ctrl and all its nodes.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_msg(msg, qos=0, retain=False)[source]¶

Publish an heartbeat message.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_resolv_msg(msg, qos=0, retain=False)[source]¶

Publish an heartbeat message.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_value(hadd, value, genre='user', qos=0, retain=False)[source]¶

Publish a value.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

class janitoo.mqtt.MQTTClient(client_id=None, options=None, loop_sleep=0.15)[source]¶

Bases: threading.Thread

add_topic(topic=None, callback=None)[source]¶

Register a message callback for a specific topic.

Messages that match ‘topic’ will be passed to ‘callback’. Any non-matching messages will be passed to the default on_message callback.

Call multiple times with different ‘sub’ to define multiple topic specific callbacks.

Topic specific callbacks may be removed with message_callback_remove().

Parameters:	topic (str) – a string specifying the subscription topic to subscribe to. callback (func) – the function called when a message arrived.

connect()[source]¶: Connect to the mqtt broker

mqtt_on_connect(client, userdata, flags, rc)[source]¶

Called when the broker responds to our connection request.

Parameters:

client (paho.mqtt.client.Client) – the Client instance that is calling the callback.
userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata).
flags (dict) – flags is a dict that contains response flags from the broker: flags[‘session present’] - this flag is useful for clients that are using clean session set to 0 only. If a client with clean session=0, that reconnects to a broker that it has previously connected to, this flag indicates whether the broker still has the session information for the client. If 1, the session still exists.
rc (in) – the value of rc determines success or not: 0: Connection successful 1: Connection refused - incorrect protocol version 2: Connection refused - invalid client identifier 3: Connection refused - server unavailable 4: Connection refused - bad username or password 5: Connection refused - not authorised 6-255: Currently unused.

mqtt_on_log(client, userdata, level, buff)[source]¶

called when the client has log information. Define to allow debugging.

Parameters:

client (paho.mqtt.client.Client) – the Client instance that is calling the callback.
userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata).
level (int) – The level variable gives the severity of the message and will be one of MQTT_LOG_INFO, MQTT_LOG_NOTICE, MQTT_LOG_WARNING, MQTT_LOG_ERR, and MQTT_LOG_DEBUG.
buff (str) – The message itself.

mqtt_on_message(client, userdata, message)[source]¶

Called when a message has been received on a topic that the client subscribes to.

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

mqtt_on_publish(client, userdata, mid)[source]¶

called when a message that was to be sent using the publish() call has completed transmission to the broker.

For messages with QoS levels 1 and 2, this means that the appropriate handshakes have completed. For QoS 0, this simply means that the message has left the client. This callback is important because even if the publish() call returns success, it does not always mean that the message has been sent.

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). mid (unknow) – (Not used) The mid variable matches the mid variable returned from the corresponding publish() call, to allow outgoing messages to be tracked.

mqtt_on_subscribe(client, userdata, mid, granted_qos)[source]¶

called when the broker responds to a subscribe request.

Parameters:

client (paho.mqtt.client.Client) – the Client instance that is calling the callback.
userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata).
mid (unknow) – (Not used) The mid variable matches the mid variable returned from the corresponding publish() call, to allow outgoing messages to be tracked.
granted_qos (list()) – The granted_qos variable is a list of integers that give the QoS level the broker has granted for each of the different subscription requests..

publish(topic, payload=None, qos=0, retain=False)[source]¶

Publish a message on a topic.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

topic (str) – The topic that the message should be published on.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat(add_ctrl, add_node, state='ONLINE', qos=0, retain=False)[source]¶

Publish an heartbeat for the node add_ctrl, add_node.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_controller(add_ctrl, state='ONLINE', qos=0, retain=False)[source]¶

Publish an heartbeat for the controller add_ctrl and all its nodes.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_msg(msg, qos=0, retain=False)[source]¶

Publish an heartbeat message.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_heartbeat_resolv_msg(msg, qos=0, retain=False)[source]¶

Publish an heartbeat message.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_reply(uuid, payload=None, qos=0, retain=False)[source]¶

Publish an uuid reply to clients.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

publish_value(hadd, value, genre='user', qos=0, retain=False)[source]¶

Publish a value.

This causes a message to be sent to the broker and subsequently from the broker to any clients subscribing to matching topics.

Parameters:

uuid (str) – The uuid sent in the request.
payload (message) – The actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require.
qos (int) – The quality of service level to use.
retain (bool) – If set to true, the message will be set as the “last known good”/retained message for the topic.

remove_topic(topic=None)[source]¶

Remove a message callback previously registered with message_callback_add().

Parameters:	topic (str) – a string specifying the subscription topic to subscribe to.

run()[source]¶: Run the loop

stop()[source]¶: Stop the mqtt thread

subscribe(topic=None, topics=None, qos=0, callback=None)[source]¶

Subscribe to a topic

This function may be called in three different ways:

e.g. subscribe(“my/topic”, 2)

topic: A string specifying the subscription topic to subscribe to. qos: The desired quality of service level for the subscription.

Defaults to 0.

e.g. subscribe((“my/topic”, 1))

topic: A tuple of (topic, qos). Both topic and qos must be present in: the tuple.

qos: Not used.

e.g. subscribe([(“my/topic”, 0), (“another/topic”, 2)])

This allows multiple topic subscriptions in a single SUBSCRIPTION command, which is more efficient than using multiple calls to subscribe().

topic: A list of tuple of format (topic, qos). Both topic and qos must: be present in all of the tuples.

qos: Not used.

Parameters:	topic (str) – a string specifying the subscription topic to subscribe to. qos (int) – the desired quality of service level for the subscription. Defaults to 0. callback (func) – the function called when a message arrived.

subscribe_reply(uuid=None, qos=0, callback=None)[source]¶

Subscribe to the reply mechanisme

Parameters:	uuid (str) – An uuid. qos (int) – the desired quality of service level for the subscription. Defaults to 0. callback (func) – the function called when a message arrived.

unsubscribe(topic)[source]¶

Unsubscribe the client from one or more topics.

Parameters:	topic (str) – a string specifying the subscription topic to subscribe to.

Raises a ValueError if topic is None or has zero string length, or is not a string or list.

unsubscribe_reply(uuid)[source]¶

Unsubscribe the client from one or more topics.

Parameters:	topic (str) – a string specifying the subscription topic to subscribe to.

Raises a ValueError if topic is None or has zero string length, or is not a string or list.

janitoo.node module¶

The Node

about the pollinh mechanism :

simplest way to do it : define a poll_thread_timer for every value that needed to publish its data
Add a kind of polling queue that will launch the method to get and publish the value

class janitoo.node.JNTBusNodeMan(options, bus, section, thread_uuid, **kwargs)[source]¶

Bases: janitoo.node.JNTNodeMan

The node manager

after_config_node(uuid)[source]¶: After configuring the node

after_controller_reply_config()[source]¶: Start the bus

after_fsm_stop()[source]¶

before_controller_reply_config()[source]¶

build_bus_components()[source]¶: Build the bus components from factory

create_controller_node(**kwargs)[source]¶

create_node(uuid, hadd, **kwargs)[source]¶

get_nodes_hadds_from_local_config()[source]¶: {‘uuid’:’hadd’}

loop(stopevent)[source]¶

stop()[source]¶

class janitoo.node.JNTNode(uuid='a_unik_identifier_for_the_node_on_the_controller', **kwargs)[source]¶

Bases: object

add_internal_config_values()[source]¶

add_internal_system_values()[source]¶

add_value(uuid, value)[source]¶

capabilities = None¶: The capabilities implemented by the node

check_heartbeat()[source]¶: Check

cmd_classes = None¶: The command classes implemented by the node

config_timeout = None¶: The delay before reloading the thread

config_timeout_get(node_uuid, index)[source]¶

config_timeout_set(node_uuid, index, value, create=False)[source]¶

create_options(component_uuid)[source]¶: Create options for a node

from_dict(adict)[source]¶: Update internal dict from adict

hadd[source]¶

hadd_get(node_uuid, index)[source]¶

hadd_set(node_uuid, index, value, create=False)[source]¶

heartbeat = None¶: The heartbeat delay

heartbeat_get(node_uuid, index)[source]¶

heartbeat_set(node_uuid, index, value, create=False)[source]¶

load_config_from_local()[source]¶: Retrieve a json version of the node

load_system_from_local()[source]¶: Retrieve a json version of the node

location = None¶: The location of the node

location_get(node_uuid, index)[source]¶

location_set(node_uuid, index, value, create=False)[source]¶

name = None¶: The name of the node

name_get(node_uuid, index)[source]¶

name_set(node_uuid, index, value, create=False)[source]¶

oid = None¶: The oid of the component associated to the node

options = None¶: The option inherited from startup

product_manufacturer = None¶: The product manufacturer of the node

product_name = None¶: The product name of the node

product_type = None¶: The product type of the node

split_hadd()[source]¶: Return the node part of the address node

to_dict()[source]¶: Retrieve a dict version of the node

to_json()[source]¶: Retrieve a json version of the node

update_bus_options(component_uuid)[source]¶: Create options for a node

uuid = None¶: The UUID of the node

values = None¶: The values assumed by the node

class janitoo.node.JNTNodeMan(options, section, thread_uuid, **kwargs)[source]¶

Bases: object

The node manager

add_controller_node(uuid, node)[source]¶

add_daily_job(callback)[source]¶: Add an daily job.

add_heartbeat(node)[source]¶: Add a node to the heartbeat system

add_hourly_job(callback)[source]¶: Add an hourly job.

add_internal_config_values_to_node(node)[source]¶

add_internal_system_values_to_node(node)[source]¶

add_node(uuid, node)[source]¶

add_poll(value, timeout=None, overwrite=True)[source]¶: Add a value to the polling system

add_polls(values, timeout=None, slow_start=False, overwrite=True)[source]¶: Add values to the polling system

add_value_to_node(uuid, node, value)[source]¶

after_config_node(uuid)[source]¶: After the node config

after_controller_reply_config()[source]¶

after_controller_reply_system()[source]¶

after_create_node(uuid)[source]¶: After the node is created

after_fsm_stop()[source]¶

after_system_node(uuid)[source]¶: After the node system

before_controller_reply_config()[source]¶

create_controller_node(**kwargs)[source]¶

create_fsm()[source]¶

create_node(uuid, **kwargs)[source]¶

do_hourly_timer()[source]¶: Do the hourly timer thread

find_bus_value(value_uuid, oid=None)[source]¶: Find a bus value using its uuid

find_node(node_uuid)[source]¶: Find a node using its uuid

find_node_by_hadd(node_hadd)[source]¶: Find a node using its uuid

find_nodes(node_oid)[source]¶: Find a node usinf its uuid

find_value(node_uuid, value_uuid)[source]¶: Find a value using its uuid and the node one

finish_controller_reply_config()[source]¶

finish_controller_reply_system()[source]¶

finish_controller_uuid()[source]¶

finish_nodes_config()[source]¶

finish_nodes_hadds()[source]¶

finish_nodes_system()[source]¶

fsm_states = [<transitions.core.State object at 0x2b74cafbfd10>, <transitions.core.State object at 0x2b74cafbfd50>, <transitions.core.State object at 0x2b74cafbfd90>, <transitions.core.State object at 0x2b74cafbfdd0>, <transitions.core.State object at 0x2b74cafbfe10>, <transitions.core.State object at 0x2b74cafbfe50>, <transitions.core.State object at 0x2b74cafbfe90>]¶

get_add_ctrl()[source]¶

get_components()[source]¶: Retrieve components from a section

get_controller_node()[source]¶

get_node_from_hadd(hadd)[source]¶

get_node_from_uuid(uuid)[source]¶

get_nodes_hadds_from_local_config()[source]¶: {‘uuid’:’hadd’}

heartbeat(nodes, mqttc=None, stopevent=None)[source]¶: Send a add_ctrl:-1 heartbeat message. It will ping all devices managed by this controller.

is_polled(value)[source]¶: Is the value poll active (in the polling system)

is_started[source]¶: Return True if the network is started

is_stopped[source]¶: Return True if the network is stopped

loop(stopevent)[source]¶

on_generic_request(client, userdata, message)[source]¶

On request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_reply(client, userdata, message)[source]¶

On request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

on_request(client, userdata, message)[source]¶

On request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

publish_poll(mqttc, value, stopevent=None)[source]¶

publish_request(reply_topic, msg)[source]¶

publish_value(value, data=None)[source]¶

remove_daily_job(callback)[source]¶: Remove an daily job.

remove_heartbeat(node)[source]¶: Remove a node from the heartbeat system

remove_hourly_job(callback)[source]¶: Remove an hourly job.

remove_poll(value)[source]¶: Remove poll from polling system

remove_polls(values)[source]¶: Remove polls from polling system

request_info_basics(reply_topic, resp)[source]¶

request_info_commands(reply_topic, resp)[source]¶

request_info_configs(reply_topic, resp)[source]¶

request_info_nodes(reply_topic, resp)[source]¶

request_info_systems(reply_topic, resp)[source]¶

request_info_users(reply_topic, resp)[source]¶

start(trigger_reload=None, loop_sleep=0.1, slow_start=0.05)[source]¶

start_broadcast_request()[source]¶

start_controller_reply()[source]¶

start_controller_reply_config()[source]¶

start_controller_reply_system()[source]¶

start_controller_uuid()[source]¶

start_heartbeat_sender()[source]¶

start_hourly_timer()[source]¶: Start the hourly timer

start_nodes_init()[source]¶

start_nodes_request()[source]¶

states_str = {'BOOT': 'The nodes are booting', 'SYSTEM': 'Configuring the nodes (system)', 'INIT': 'Initialising the nodes', 'ONLINE': 'The nodes are online', 'OFFLINE': 'The nodes are offline', 'CONFIG': 'Configuring the nodes'}¶

stop()[source]¶

stop_boot_timer()[source]¶

stop_broadcast_request()[source]¶

stop_controller_reply()[source]¶

stop_controller_uuid()[source]¶

stop_heartbeat_sender()[source]¶

stop_hourly_timer()[source]¶: Stop the hourly timer

stop_nodes_request()[source]¶

janitoo.options module¶

The thread

A thread that handle a bus, ... ie i2e, onewire,

It also handle the controller for the janitoo protocol

How do what :

The tread :

hold the mqttc
ask the nodeman to boot : - get an HADD for the controller - get configuration for the controller and start the i2c bus, the onewire bus, ..... - get an HADD for each nodes - get configuration of the node and start it : ie the lcd03 of i2c, the cpu of the rapsy, ...

Reloading configration:

inside the run loop of the thread so need to kill it and re-create a new one : only possible in the server. The server (=the rapsy server) can do it but it should be accessible on mqtt.

class janitoo.options.JNTOptions(options=None)[source]¶

Bases: object

get_component_settings(section, component)[source]¶: Retrieve component’s configuration from a section

get_option(section, key, default=None)[source]¶: Retrieve options from a section

get_options(section)[source]¶: Retrieve options from a section

get_options_key(section, key, strict=False)[source]¶: Retrieve options which started with a key from a section

get_sections()[source]¶: Retrieve all sections

get_settings(section)[source]¶: Retrieve settings from a section

load()[source]¶

Load system section from file

Parameters:	options – The options used to start the worker.

remove_options(section)[source]¶: Remove a n entire section

set_option(section, key, value, create=False)[source]¶: Set option in a section

set_options(section, data)[source]¶: Retrieve options from a section

janitoo.options.get_option_autostart(options, section)[source]¶: Retrieve auto_start option from a section

janitoo.options.string_to_bool(data)[source]¶: Convert a string to bool

janitoo.rfid module¶

The RFID format for Janitoo

https://github.com/adafruit/Adafruit_Python_PN532/blob/master/examples/mcpi_write.py https://www.itead.cc/blog/to-drive-itead-pn532-nfc-module-with-raspberry-pi

We got almost 64 blocks of 16 bytes on the card. It seems that we could authenticate and read one block at a time.

2 choices :

we use each block separatly :

rfid[0] : the version rfid[1] : 0 rfid[2] : type rfid[3] : subtype rfid[4] : control rfid[5] : 0 rfid[6:..] : specific

but :

how to know how many tags are available on the card

we use the first block as a block allocation table :

type, subtype -> block

We can mix many subtypes (ie admin + access) combining bits

The specific part wil be a token which allow :

to check againt a pki that the token is valid for this card, this type and subtype.
to allow specific thinks : ie when presence is sleeping and watchdog, se should activate presence detector on outiside zone.

class janitoo.rfid.RFIDBlock(**kwargs)[source]¶

Bases: janitoo.rfid.RFIDBlock01

A RFID block This is the interface to be use by developpers

class janitoo.rfid.RFIDBlock00(**kwargs)[source]¶

Bases: object

A RFID card version 0 We should allow multiple version format.

from_bytes(data)[source]¶: Import data from a byte array

get_version(data)[source]¶: Extract version from a byte array

to_bytes(upgrade=False)[source]¶: Convert message to a byte array If uograde is True, the message is udpdated to current version.

class janitoo.rfid.RFIDBlock01(**kwargs)[source]¶

Bases: janitoo.rfid.RFIDBlock00

An RFID card version 1

class janitoo.rfid.RFIDTag(**kwargs)[source]¶

Bases: object

A RFID tag Can contain up to 64 blocks.

The reader and writer callbacks :

def writer(blockid, blockdata):

should return True if everything isk ok

def reader(blockid):

return bytesarray or None if no (more) data

erase(writer, full=False)[source]¶: Format the tag for Janitoo if full, erase all blocks

from_reader(reader)[source]¶: Retrieve tag from reader

to_writer(writer, upgrade=False)[source]¶: Send the tag to the writer

janitoo.rfid.decode_rfid_block(rfid_bytes)[source]¶: Try to decode a bytearray in a Janitoo RFID block :returns: A block

janitoo.rfid.decode_rfid_tag(reader)[source]¶: Try to decode RFID blocks on an RFID tag

janitoo.runner module¶

The runner

Start a worker or a broker as a daemon.

Must be updated to work with multiple workers.

What do we need :

the user ou userid
the log file
the error output
the standard output
the pid file
the working directory

Based on the runner of python-daemon :

class janitoo.runner.Runner(only_front=False)[source]¶

Bases: object

Controller for a callable running in a separate background process.

The first command-line argument is the action to take:

‘start’: Become a daemon and call app.run().
‘stop’: Exit the daemon process specified in the PID file.
‘restart’: Stop, then start.
‘status’: Show the status of the process.

action_funcs = {'status': <function _status at 0x2b74cbfb38c0>, 'start': <function _start at 0x2b74cbfb35f0>, 'kill': <function _kill at 0x2b74cbfb3848>, 'reload': <function _reload at 0x2b74cbfb39b0>, 'front': <function _front at 0x2b74cbfb3668>, 'flush': <function _flush at 0x2b74cbfb3a28>, 'stop': <function _stop at 0x2b74cbfb37d0>, 'restart': <function _restart at 0x2b74cbfb3938>}¶

app_run()[source]¶: The running process of the application

app_shutdown()[source]¶: The shutdown process of the application

do_action()[source]¶: Perform the requested action.

parse_args(only_front=False)[source]¶: Parse command-line arguments.

start_message = 'started with pid %d'¶

status_message_not_running = 'process is not running'¶

status_message_running = 'process is running (%d)'¶

exception janitoo.runner.RunnerError[source]¶

Bases: exceptions.Exception

Abstract base class for errors.

exception janitoo.runner.RunnerInvalidActionError[source]¶

Bases: exceptions.ValueError, janitoo.runner.RunnerError

Raised when specified action is invalid.

exception janitoo.runner.RunnerStartFailureError[source]¶

Bases: exceptions.RuntimeError, janitoo.runner.RunnerError

Raised when failure starting.

exception janitoo.runner.RunnerStopFailureError[source]¶

Bases: exceptions.RuntimeError, janitoo.runner.RunnerError

Raised when failure stopping.

janitoo.runner.emit_message(message, stream=None)[source]¶: Emit a message to the specified stream (default sys.stderr).

janitoo.runner.is_pidfile_stale(pidfile)[source]¶

Determine whether a PID file is stale.

Return True (“stale”) if the contents of the PID file are valid but do not match the PID of a currently-running process; otherwise return False.

janitoo.runner.jnt_parse_args(only_front=False)[source]¶: Default argument parser

janitoo.runner.make_pidlockfile(path, acquire_timeout)[source]¶: Make a PIDLockFile instance with the given filesystem path.

janitoo.server module¶

The base server for Janitoo

we must add a method to reload a thread (a key from entry point) : install new thread, update a thread

class janitoo.server.JNTControllerManager[source]¶

Bases: object

A node dedicated for a special thread/server like the the DHCP server or the listener thread in the webapp

add_more_values(**kwargs)[source]¶: Add more values

add_poll(value, timeout=None)[source]¶

get_controller()[source]¶: Return the controller

get_controller_hadd()[source]¶: Return the controller hadd

heartbeat_controller()[source]¶: Send a add_ctrl:-1 heartbeat message. It will ping all devices managed by this controller.

on_controller_request(client, userdata, message)[source]¶

On request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

publish_poll(mqttc, value, stopevent=None)[source]¶

publish_request(reply_topic, msg)[source]¶

remove_poll(value)[source]¶

request_info_basics(reply_topic, resp)[source]¶

request_info_commands(reply_topic, resp)[source]¶

request_info_configs(reply_topic, resp)[source]¶

request_info_nodes(reply_topic, resp)[source]¶

request_info_systems(reply_topic, resp)[source]¶

request_info_users(reply_topic, resp)[source]¶

start_controller(section, options, **kwargs)[source]¶: Start the controller

start_controller_timer()[source]¶: Start the controller tier

stop_controller()[source]¶: Stop the controller

stop_controller_timer()[source]¶: Stop the controller timer

class janitoo.server.JNTServer(options)[source]¶

Bases: object

The Janitoo base Server

find_thread(section)[source]¶: Find a thread using its oid (section)

flush()[source]¶: Flush the server’s data to disk

get_package_name()[source]¶

Return the name of the package. Needed to publish static files

MUST be copy paste in every extension that publish statics files

post_loop()[source]¶: After the loop

pre_loop()[source]¶: Before enterig the loop

reload()[source]¶: Reload the server

reload_threads()[source]¶: Reload the threads

resource_filename(path='public')[source]¶: Needed to publish static files

run()[source]¶: Run the loop

sighup_handler(signal, frame)[source]¶: Catch SIGHUP signal

sigterm_handler(signal, frame)[source]¶: Catch SIGTERM signal

sigusr1_handler(signal, frame)[source]¶: Catch SIGUSR1 signal The server must flush its data to disk The mosquitto broker use it to persist its database to disk.

start()[source]¶: Start the server. Must be called at the end of the children class.

stop()[source]¶: Stop the server. Must be called at begin if overloaded in the children class

janitoo.server_updater module¶

The update process of the server :

will be used to update the computer on which the server is installed.

Ideally , we need only one updater by computer (or many in the case of many virtual env).

What should we update ? :

the time : with the help of ntp ?
distribution packages
janitoo distribution packages
janitoo python modules

Most of this operations need the help of root user. We should prefer the use of sudo.

Some of them should be done using the cron system of the janitoo user : https://pypi.python.org/pypi/python-crontab. Date and time should be updatable by the user. The use can disable them too.

class janitoo.server_updater.JNTControllerManager[source]¶

Bases: object

A node dedicated for a special thread/server like the the DHCP server or the listener thread in the webapp

get_controller()[source]¶: Return the controller

get_controller_hadd()[source]¶: Return the controller hadd

heartbeat_controller()[source]¶: Send a add_ctrl:-1 heartbeat message. It will ping all devices managed by this controller.

on_controller_request(client, userdata, message)[source]¶

On request

Parameters:	client (paho.mqtt.client.Client) – the Client instance that is calling the callback. userdata (all) – user data of any type and can be set when creating a new client instance or with user_data_set(userdata). message (paho.mqtt.client.MQTTMessage) – The message variable is a MQTTMessage that describes all of the message parameters.

publish_request(reply_topic, msg)[source]¶

request_info_basics(reply_topic, resp)[source]¶

request_info_commands(reply_topic, resp)[source]¶

request_info_configs(reply_topic, resp)[source]¶

request_info_nodes(reply_topic, resp)[source]¶

request_info_systems(reply_topic, resp)[source]¶

request_info_users(reply_topic, resp)[source]¶

start_controller(section, options, **kwargs)[source]¶: Start the controller

start_controller_timer()[source]¶: Start the controller tier

stop_controller()[source]¶: Stop the controller

stop_controller_timer()[source]¶: Stop the controller timer

class janitoo.server_updater.JNTServer(options)[source]¶

Bases: object

The Janitoo base Server

flush()[source]¶: Flush the server’s data to disk

post_loop()[source]¶: After the loop

pre_loop()[source]¶: Before enterig the loop

reload()[source]¶: Reload the server

reload_threads()[source]¶: Reload the threads

run()[source]¶: Run the loop

sighup_handler(signal, frame)[source]¶: Catch SIGHUP signal

sigterm_handler(signal, frame)[source]¶: Catch SIGTERM signal

sigusr1_handler(signal, frame)[source]¶: Catch SIGUSR1 signal The server must flush its data to disk The mosquitto broker use it to persist its database to disk.

start()[source]¶: Start the server. Must be called at the end of the children class.

start_threads()[source]¶: Start the threads associated to this server.

stop()[source]¶: Stop the server. Must be called at begin if overloaded in the children class

janitoo.tests module¶

The fake thread and components for tests

class janitoo.tests.FakeBus(**kwargs)[source]¶

Bases: janitoo.bus.JNTBus

A fake bus

check_heartbeat()[source]¶: Check that the component is ‘available’

class janitoo.tests.FakeComponent(bus=None, addr=None, **kwargs)[source]¶

Bases: janitoo.component.JNTComponent

A fake component

check_heartbeat_file(filename)[source]¶: Check that the component is ‘available’

class janitoo.tests.FakeThread(options=None)[source]¶

Bases: janitoo.thread.JNTBusThread

The Http thread

init_bus()[source]¶: Build the bus

janitoo.tests.make_fake_component(**kwargs)[source]¶

janitoo.tests.make_thread(options, force=False)[source]¶

janitoo.thread module¶

The thread

A thread that handle a bus, ... ie i2e, onewire,

It also handle the controller for the janitoo protocol

How do what :

The tread :

hold the mqttc
ask the nodeman to boot : - get an HADD for the controller - get configuration for the controller and start the i2c bus, the onewire bus, ..... - get an HADD for each nodes - get configuration of the node and start it : ie the lcd03 of i2c, the cpu of the rapsy, ...

Reloading configration:

inside the run loop of the thread so need to kill it and re-create a new one : only possible in the server. The server (=the rapsy server) can do it but it should be accessible on mqtt.

class janitoo.thread.BaseThread(options=None)[source]¶

Bases: threading.Thread

config_timeout_callback()[source]¶: Called when configuration is finished.

get_package_name()[source]¶

Return the name of the package. Needed to publish static files

MUST be copy paste in every extension that publish statics files

init_section()[source]¶: Init the section. Must be overloaded

post_loop()[source]¶: Launch after finishing the run loop. The node manager is still available.

post_run()[source]¶: Launch before exititng the run methode. You should dereference here.

pre_loop()[source]¶: Launch before entering the run loop. The node manager is available.

reload()[source]¶: Stop the thread

resource_filename(path='public')[source]¶: Needed to publish static files

stop()[source]¶: Stop the thread

stop_trigger_reload(timeout=None)[source]¶: Stop reload trigger.

trigger_reload(timeout=None)[source]¶: Trigger the config_timeout_callback to reload config.

class janitoo.thread.JNTBusThread(options=None)[source]¶

Bases: janitoo.thread.JNTThread

create_nodeman()[source]¶

init_bus()[source]¶: Init the bus. Must be overloaded

post_loop()[source]¶: After the loop is finished

post_run()[source]¶: Launch before exititng the run methode. You should dereference here. Derefernce the bus

class janitoo.thread.JNTThread(options=None)[source]¶

Bases: janitoo.thread.BaseThread

create_nodeman()[source]¶: Create the node manager

run()[source]¶: Run the loop

state[source]¶: Return the nodeman state

janitoo.utils module¶

The common utils

exception janitoo.utils.JanitooException(exx='Janitoo Exception', message='')[source]¶

Bases: exceptions.Exception

Exception class for Janitoo

exception janitoo.utils.JanitooNotImplemented(message='')[source]¶

Bases: janitoo.utils.JanitooException

Not Implemented Exception class for Janitoo

exception janitoo.utils.JanitooRuntime(message='')[source]¶

Bases: janitoo.utils.JanitooException

Runtime Exception class for Janitoo

janitoo.utils.deprecated(func)[source]¶: This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emmitted when the function is used.

janitoo.utils.hadd_split(hadd)[source]¶

janitoo.utils.json_dumps(data_as_object)[source]¶

janitoo.utils.json_loads(data_as_string)[source]¶

janitoo.value module¶

The value

class janitoo.value.JNTValue(uuid='a_unik_identifier_for_the_value_on_the_controller', node_uuid='the_unik_identifier_of_the_node', get_data_cb=None, set_data_cb=None, **kwargs)[source]¶

Bases: object

cmd_class = None¶: The command class implemented by the value

convert(data)[source]¶

Convert data to the type of value

Returns:	The data of the value
Return type:	depending of the type of the value

data[source]¶

Get the current data of the value.

Returns:	The data of the value
Return type:	depending of the type of the value

default = None¶: The default data of the value

from_dict(adict)[source]¶: Update internal dict from adict

genre = None¶: The genre of the value

hadd = None¶: The HADD of the node associated to this value

help = None¶: The label of the value

index = None¶: Get the value index (use with multi_instance nodes)

is_polled = None¶: Say if the value is polled

is_readonly = None¶: Is the value readonly

is_writeonly = None¶: Is the value writeonly

label = None¶: The help of the value

list_items = None¶: The list of all valid items when the value type is list. This list is separated with pipe : ‘|’

master_config_value = None¶: The master_value. Used with value_factory entries

max = None¶: The max of the value

min = None¶: The min of the value

node_uuid = None¶: The UUID of the node the valuse is attached to

poll_delay = None¶: The delay between 2 polls

reply_hadd = None¶: The hadd to reply to

start()[source]¶: Start the value. Can be used to start a thread to acquire data. This method is not called in the nodeman process. Programmer must call it manually, ie at stat machine change.

stop()[source]¶: Stop the value. This method is not called in the nodeman process. Programmer must call it manually, ie at stat machine change.

to_dict()[source]¶

Retrieve a dict version of the value. Include all properties except :

ends with lock, _cb,

starts with timer, _

So use the naming convention above or ask for update if you really need it.

to_json()[source]¶: Retrieve a json version of the value

type = None¶: The type of the value

units = None¶: The units of the value

uuid = None¶: The UUID of the value

voice_uuid = None¶: The voice_uuid of this value. Can be use to a

janitoo.value.value_config_location(get_data_cb, set_data_cb)[source]¶

janitoo.value.value_config_name(get_data_cb, set_data_cb)[source]¶

janitoo.value.value_config_poll(uuid, get_data_cb, set_data_cb, help='The poll delay of the value', label='poll_delay', index=0, default=300)[source]¶

janitoo.value.value_system_config_timeout(get_data_cb, set_data_cb)[source]¶

janitoo.value.value_system_hadd(get_data_cb, set_data_cb)[source]¶

janitoo.value.value_system_heartbeat(get_data_cb, set_data_cb)[source]¶

janitoo.value_factory module¶

The value

class janitoo.value_factory.JNTValueFactoryEntry(uuid='value_entry_uuid', **kwargs)[source]¶

Bases: janitoo.value.JNTValue

Implement a value entry for the factory. Used to create complex values.

create_config_value(**kwargs)[source]¶

create_poll_value(**kwargs)[source]¶

get_config(node_uuid, index)[source]¶

get_data_index(node_uuid=None, index=None, config=None)[source]¶

get_index_configs()[source]¶

get_length(node_uuid=None)[source]¶: Returns the number of defindes instances

get_max_index(node_uuid=None)[source]¶

set_config(node_uuid, index, data)[source]¶

set_data_index(node_uuid=None, index=None, config=None, data=None)[source]¶

to_dict_with_index(index, initial=None)[source]¶: Retrieve a json version of the value

to_dict_with_indexes()[source]¶: Retrieve a dict version of the value

to_json_with_indexes()[source]¶: Retrieve a json version of the value

janitoo package¶

Submodules¶

janitoo.bus module¶

janitoo.classes module¶

janitoo.component module¶

janitoo.dhcp module¶

janitoo.fsm module¶

janitoo.mqtt module¶

janitoo.node module¶

janitoo.options module¶

janitoo.rfid module¶

janitoo.runner module¶

janitoo.server module¶

janitoo.server_updater module¶

janitoo.tests module¶

janitoo.thread module¶

janitoo.utils module¶

janitoo.value module¶

janitoo.value_factory module¶

Module contents¶