Smart-building app

backend.py

+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+import time
+import logging
+import configpi
+
+from louie import dispatcher
+from datetime import datetime
+from flask import jsonify
+from collections import OrderedDict
+
+from openzwave.network import ZWaveNetwork
+from openzwave.option import ZWaveOption
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger('openzwave')
+
+started = False
+name = configpi.name
+
+
+
+
+
+
+###########################################################################################################################
+###########################################################################################################################
+##########    Root parent backend class     ###############################################################################
+###########################################################################################################################
+###########################################################################################################################
+
+
+class Backend():
+
+    def __init__(self):
+
+	###################  instanciation de l'objet backend ########################################################
+
+
+	###### options needed for python openzwave library like config files path, logging, 
+        device = configpi.interface
+        options = ZWaveOption(device, config_path="/home/pi/IoTLab/python-openzwave/openzwave/config", user_path=".", cmd_line="")
+        options.set_log_file("OZW.log")
+        options.set_append_log_file(False)
+        options.set_console_output(False)
+        options.set_save_log_level('Warning')
+        options.set_logging(True)
+        options.lock()
+
+        # creation of the object network using the options entity already created
+        self.network = ZWaveNetwork(options, autostart=False)
+
+	###### 	 These dispatchers associate a method to a signal. the signals are generated by the library python-openzwave.
+	######   Once the signal is received. It's associated method is executed (see "_node_added" example below in "_network_started" method)
+        dispatcher.connect(self._network_started, ZWaveNetwork.SIGNAL_NETWORK_STARTED)
+        dispatcher.connect(self._network_ready, ZWaveNetwork.SIGNAL_NETWORK_READY)
+
+	###### backend object attributes
+#        self.devices = OrderedDict()  ### will contain the list of nodes in the network
+#        self.sensors = OrderedDict()  ### will contain the list of sensors (only) in the network
+        self.node_added = False
+        self.node_removed = False
+        self.timestamps = {}	      ### will contain the time of the last values' update for each sensor
+        self.queryStages = {	      ### the diffrent stages that a node object gets through before being ready 
+                "None"                  :  1, # Query process hasn't started for this node
+                "ProtocolInfo"          :  2, # Retrieve protocol information
+                "Probe"                 :  3, # Ping device to see if alive
+                "WakeUp"                :  4, # Start wake up process if a sleeping node
+                "ManufacturerSpecific1" :  5, # Retrieve manufacturer name and product ids if ProtocolInfo lets us
+                "NodeInfo"              :  6, # Retrieve info about supported, controlled command classes
+                "SecurityReport"        :  7, # Retrieve a list of Command Classes that require Security
+                "ManufacturerSpecific2" :  8, # Retrieve manufacturer name and product ids
+                "Versions"              :  9, # Retrieve version information
+                "Instances"             : 10, # Retrieve information about multiple command class instances
+                "Static"                : 11, # Retrieve static information (doesn't change)
+                "Probe1"                : 12, # Ping a device upon starting with configuration
+                "Associations"          : 13, # Retrieve information about associations
+                "Neighbors"             : 14, # Retrieve node neighbor list
+                "Session"               : 15, # Retrieve session information (changes infrequently)
+                "Dynamic"               : 16, # Retrieve dynamic information (changes frequently)
+                "Configuration"         : 17, # Retrieve configurable parameter information (only done on request)
+                "Complete"              : 18  # Query process is completed for this node
+        }
+
+#######################################################################################################################
+############# LAUNCH  #################################################################################################
+#######################################################################################################################
+
+    def _network_started(self, network):
+
+	# executed once the software representation is started. the discovery of the network components has begun. they will be mapped into objects
+
+        print("network started - %d nodes were found." % network.nodes_count)
+
+	# these dispatchers associate a method to a signal. the signals are generated by the library python-openzwave.
+	# a signal may contain a number of parameters that are passed to the method associated to the signal.
+	# for exemple, the dispatcher below associates the signal "SIGNAL_NODE_ADDED" to the method "_node_added" that is implemented below (line 111).
+	# the signal "SIGNAL_NODE_ADDED" transports two parameters which are the objects network and node.
+	# once this signal is received, these two parameters will be passed to the method "_node_added" and the method will be executed.
+
+        dispatcher.connect(self._node_added, ZWaveNetwork.SIGNAL_NODE_ADDED)
+        dispatcher.connect(self._node_removed, ZWaveNetwork.SIGNAL_NODE_REMOVED)
+
+
+        
+
+    def _network_ready(self, network):
+
+	# executed once the software representation is ready
+
+        print("network : ready : %d nodes were found." % network.nodes_count)
+        print("network : controller is : %s" % network.controller)
+        dispatcher.connect(self._value_update, ZWaveNetwork.SIGNAL_VALUE)
+
+    def _node_added(self, network, node):
+
+	# executed when node is added to the software representation. it's executed after the method "_debug_node_new" (see below)
+
+        print('node added: %s.' % node.node_id)
+        self.timestamps["timestamp" + str(node.node_id)] = "None"
+        self.node_added = True
+
+    def _node_removed(self, network, node):
+
+	# executed when node is removed from the software representation
+
+        print('node removed: %s.' % node.name)
+        self.node_removed = True
+
+
+    def _value_update(self, network, node, value):
+
+	# executed when a new value from a node is received
+
+        print('Node %s: value update: %s is %s.' % (node.node_id, value.label, value.data))
+        self.timestamps["timestamp" + str(node.node_id)] = int(time.time())
+
+
+
+
+################################################################################################################
+######################## START AND STOP THE SOFTWARE REPRESENTATION ############################################
+################################################################################################################
+
+    def start(self):
+
+	# this method starts the software representation
+        global started
+
+
+        if started:
+            print "Already started"
+            return 
+        started = True
+        self.network.start()
+        print "Z-Wave Network Starting..."
+        for i in range(0, 300):
+            if self.network.state == self.network.STATE_READY:
+                break
+            else:
+                time.sleep(1.0)
+        if not self.network.is_ready:
+            print "Network is not ready but continue anyway"
+        print "------------------------------------------------------------"
+        print "Nodes in network : %s" % self.network.nodes_count
+        print "------------------------------------------------------------"
+            
+    def stop(self):
+
+	# this method stops the software representation
+
+        global started
+	started = False
+        print "Stopping Z-Wave Network... "
+        self.network.stop()
+        
+    def reset(self):
+        if self.network.nodes_count == 1:
+            self.network.controller.hard_reset()
+            return "Hard Reset Done"
+        return "Cannot make Hard Reset while nodes included in network"
+
+
+
+
+#########################################################################################################################
+############## YOUR WORK STARTS HERE ####################################################################################
+#########################################################################################################################
+#########################################################################################################################
+
+
+
+
+#######################################################################################################################
+############# NETWORK #################################################################################################
+#######################################################################################################################
+
+        
+        
+    def network_info(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method returns a JSON that lists all network nodes and gives some informations about each one of them like the ID, neighbors, ..."
+
+
+
+
+
+#######################################################################################################################
+############# NODES #################################################################################################
+#######################################################################################################################   
+
+
+    def ordered_nodes_dict(self):
+    
+    # returns an ordered list of the network's nodes sorted by node's id
+
+        return OrderedDict(sorted(self.network.nodes.items()))
+
+
+
+    def addNode(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method passes the controller to inclusion mode and gets it out of it after 20 seconds "
+
+
+
+    def removeNode(self):
+
+        #### COMPLETE THIS METHOD ##############
+	
+	return "this method passes the controller to exclusion mode and gets it out of it after 20 seconds "
+
+
+   
+    def get_nodes_list(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method returns the list of nodes "
+
+
+
+    def set_node_location(self, n, value):
+
+	#### COMPLETE THIS METHOD ############## 
+
+        return " this method sets the location of a specific sensor node"
+
+
+
+    def set_node_name(self, n, value):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method sets the name of a specific sensor node"
+
+
+
+    def get_node_location(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method gets the location of a specific sensor node"
+
+
+
+    def get_node_name(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method gets the name of a specific sensor node"
+
+
+
+    def get_neighbours_list(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method gets the list of neighbours of a specific sensor node"
+
+
+
+    def set_node_config_parameter(self, n, param, value, size):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method sets a configuration parameter to a given value"
+
+
+
+    def get_node_config_parameter(self, n, param):
+
+        #### COMPLETE THIS METHOD ##############
+
+	 return "this method gets the value of a configuration parameter"
+
+
+
+    def get_nodes_Configuration(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method returns a JSON that gives an overview of the network and it's nodes' configuration parameters (like the ID, Wake-up Interval, Group 1 Reports, Group 1 Interval ...)"
+
+
+
+#######################################################################################################################
+############# Multisensors #################################################################################################
+#######################################################################################################################        
+
+class Backend_with_sensors(Backend):
+
+    def get_sensors_list(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+	return "this method returns the list of sensors"    
+
+
+
+    def get_temperature(self, n):
+
+        #### HERE'S AN EXAMPLE OF A METHOD THAT GETS THE TEMPERATURE OF A SPECIFIC SENSOR NODE ##############
+
+        for node in self.network.nodes.itervalues():
+            if node.node_id == n and node.isReady and n != 1 and "timestamp"+str(node.node_id) in self.timestamps:
+                values = node.get_values(0x31, "User", "All", True, False)
+                for value in values.itervalues():
+                    if value.label == "Temperature":
+                        val = round(value.data,1)
+                #        if len(node.location) < 3:
+                #            node.location = configpi.sensors[str(node.node_id)][:4]
+                        return jsonify(controller = name, sensor = node.node_id, location = node.location, type = value.label.lower(), updateTime = self.timestamps["timestamp"+str(node.node_id)], value = val)
+        return "Node not ready or wrong sensor node !"						
+
+
+
+    def get_humidity(self, n):
+
+         #### HERE'S AN EXAMPLE OF A METHOD THAT GETS THE HUMIDITY OF A SPECIFIC SENSOR NODE ##############
+
+        for node in self.network.nodes.itervalues():
+            if node.node_id == n and node.isReady and n != 1 and "timestamp"+str(node.node_id) in self.timestamps:
+                values = node.get_values(0x31, "User", "All", True, False)
+                for value in values.itervalues():
+                    if value.label == "Relative Humidity":
+                        val = int(value.data)
+                 #       if len(node.location) < 3:
+                 #           node.location = configpi.sensors[str(node.node_id)][:4]
+                        return jsonify(controller = name, sensor = node.node_id, location = node.location, type = value.label.lower(), updateTime = self.timestamps["timestamp"+str(node.node_id)], value = val)
+        return "Node not ready or wrong sensor node !"
+
+
+
+    def get_luminance(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+        
+        return "this method gets the luminance measure of a specific sensor node"
+
+
+
+    def get_motion(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+        
+        return "this method this method gets the motion measure of a specific sensor node"
+
+
+
+    def get_battery(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+        
+        return "this method this method gets the battery measure of a specific sensor node"
+
+
+
+    def get_all_Measures(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method gets all the measures of a specific sensor node"
+
+
+
+    def set_basic_nodes_configuration(self, Grp_interval, Grp_reports, Wakeup_interval):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method configures the nodes whit a specific configuration"
+
+
+
+
+
+
+
+###########################################################################################################################
+###########################################################################################################################
+##################    Dimmers class     ##################################################################################
+###########################################################################################################################
+###########################################################################################################################
+
+class Backend_with_dimmers(Backend):
+
+
+    def __init__(self):
+        Backend.__init__(self)
+    
+
+
+    def get_dimmers(self):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method returns the list of dimmers"
+
+
+
+    def set_dimmer_level(self, n, level):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method sets a dimmer's brightness level of a specific node"
+
+
+
+    def get_dimmer_level(self, n):
+
+        #### COMPLETE THIS METHOD ##############
+
+        return "this method gets a dimmer's brightness level of a specific node"
+
+
+
+
+
+
+###########################################################################################################################
+###########################################################################################################################
+##########    Dimmers and multisensors class         ######################################## #############################
+###########################################################################################################################
+###########################################################################################################################
+
+class Backend_with_dimmers_and_sensors(Backend_with_dimmers, Backend_with_sensors): # Cette classe sera utilise dans "flask-main"
+
+    pass
+
+
+
+
+

configpi.py

+name = 'Pi lab1'
+location = 'lausanne'
+interface = '/dev/ttyACM0'	#/dev/ttyUSB0 ou /dev/ttyAMA0

post_client.py

+import requests
+import json
+
+#############################################################
+#### This script sends POST or PUT http request to server ###
+#############################################################
+#### You have to uncomment the request you want to send   ###
+#############################################################
+#### POST requests contain parameters in JSON format      ###
+#############################################################
+
+
+ 
+#### Configuration of nodes
+#req = requests.post('http://192.168.1.2:5000/network/set_nodes_basic_configuration',headers={'Content-Type': 'application/json'}, data=json.dumps({'Group_Interval': '240','Group_Reports':'240', 'Wake-up_Interval': '480'}))
+
+
+#### Config a specific parameter
+#req = requests.post('http://192.168.1.2:5000/nodes/set_parameter',headers={'Content-Type': 'application/json'}, data=json.dumps({'node_id': '4','value':'480', 'parameter_index': '111', 'size': '4'}))
+
+
+#### Set node location
+#req = requests.post('http://192.168.1.2:5000/nodes/set_location',headers={'Content-Type': 'application/json'}, data=json.dumps({'node_id': '4','value':'A402'}))
+
+
+#### Set node name
+#req = requests.post('http://192.168.1.2:5000/nodes/set_name',headers={'Content-Type': 'application/json'}, data=json.dumps({'node_id': '4','value':'sensor'}))
+
+
+#### Send command to switch
+#req = requests.post('http://192.168.1.2:5000/switches/send_command',headers={'Content-Type': 'application/json'}, data=json.dumps({'node_id': '3','value':'on'}))
+
+#### Send command to dimmer
+req = requests.post('http://192.168.1.2:5000/dimmers/set_level',headers={'Content-Type': 'application/json'}, data=json.dumps({'node_id': '6','value':'120'}))
+
+#### Put controller in inclusion mode
+#req = requests.put('http://192.168.1.2:5000/nodes/add_node')
+
+
+#### Put controller in exclusion mode
+#req = requests.put('http://192.168.1.2:5000/nodes/remove_node')
+
+
+print (req.text)  # print server response

templates/index.html

+<!DOCTYPE html>
+<html>
+	<head>
+		<title>{{ title }}</title>
+		<style>
+			h1{
+				text-align: center;
+			}
+			
+			table{
+				margin-left: 3em;
+				margin-bottom: 3em; 
+				border-collapse:collapse; 
+				border: 1px solid black;
+			}
+			
+			table tr:first-child{
+				background-color: yellow; 
+				color: black; 
+				font-size: x-large;
+				text-align: left;
+			}
+			
+			table tr:first-child th:first-child{
+				width: 1000px;
+			}
+
+			
+			table tr:first-child th:first-child{
+				color: black;
+				width: 400px;
+				text-align: center;
+			}
+
+			table tr:nth-child(n+2) td:first-child{
+				color: green;
+				font-size: large;
+				text-align: center;
+				
+			}
+
+			table tr:nth-child(n) td:nth-child(2){
+
+				width: 1000px;
+
+			}
+
+
+			table tr:first-child th:nth-child(3){
+				width: 3000px;
+			}
+			
+			table tr{
+				border: 1px solid black;
+			}
+			
+			span{
+				font-family:'Courier New';
+				font-size:13
+			}
+		</style>
+	</head>
+
+
+
+	<body>
+		<h1>API Documentation</h1>
+		<p>Due to the Z-Wave specific protocol, this API Rest uses GET & POST methods for every endpoints (network, sensors, switches).</p>
+
+
+
+
+		
+		<h2>Network Endpoints</h2>
+		<table>
+			<tr>
+				<th>Method</th>
+				<th>Routes</th>
+				<th>Description</th>
+			</tr>
+
+			<tr>
+				<td>GET</td>
+				<td><b><a href="/network/info">/network/info</a></b></td>
+				<td>Gets information about the Z-Wave network in a JSON format</td>
+			</tr>
+			<tr>
+				<td style="color: red;">POST</td>
+				<td><b>/network/set_nodes_basic_configuration</b><br/>
+				<td>Configure all nodes of the network with a predefined configuration. This methods configures only Group 1. All measurements (temperature, luminosity, motion and humidity) must be retrieved from the sensors after a given period of time (Group_Interval Number).</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b><a href="/network/get_nodes_configuration">/network/get_nodes_configuration</a></b><br/>
+				<td>Gets the list of nodes and their configuration parameters in a JSON format</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/network/start</b><br/>
+				<td>Start the Z-Wave Network</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/network/stop</b><br/>
+				<td>Stop the Z-Wave Network</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/network/reset</b><br/>
+				<td>Reset the Z-Wave Network</td>
+			</tr>
+		</table>
+        
+
+
+
+		<h2>Nodes Endpoints (All nodes)</h2>
+		<table>
+			<tr>
+				<th>Method</th>
+				<th>Routes</th>
+				<th>Description</th>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b><a href="/nodes/get_nodes_list">/nodes/get_nodes_list</a></b></td>
+				<td>List all nodes in the network</td>
+			</tr>
+			<tr> 
+				<td style="color: maroon;">PUT</td> 
+				<td><b>/nodes/add_node</b></td>
+				<td>Adds Node to the network by getting the controller into inclusion mode for 20 seconds. The node can not be a controller.</td>
+			</tr>
+			<tr>  
+				<td style="color: maroon;">PUT</td>
+				<td><b>/nodes/remove_node</b></td>
+				<td>Removes Node from the network by getting the controller into exclusion mode for 20 seconds</td>
+			</tr>
+                        <tr>
+				<td style="color: red;">POST</td>
+                                <td><b>/nodes/set_parameter</b></td>
+                                <td>Sets the value of a given parameter of a node</td>
+                        </tr>
+                        <tr>
+				<td>GET</td>
+                                <td><b>/nodes/{$node_id}/get_parameter/{$parameter_index}</b></td>
+                                <td>Gets the value of a given parameter for node $node_id</td>
+                        </tr>
+                        <tr>
+				<td>GET</td>
+                                <td><b>/nodes/{$node_id}/get_battery</b></td>
+                                <td>Return current level of battery for node $node_id</td>
+                        </tr>
+                        <tr>
+				<td>GET</td>
+                                <td><b>/nodes/{$node_id}/get_neighbours</b></td>
+                                <td>Return the list of neighbors for node $node_id</td>
+                        </tr>
+			<tr>
+				<td style="color: red;">POST</td>
+				<td><b>/nodes/set_name</b></td>
+				<td>Set a new name of the node</td>
+			</tr>
+			<tr>
+				<td style="color: red;">POST</td>
+				<td><b>/nodes/set_location</b></td>
+				<td>Set the new location of a node</td>
+			</tr>
+                        <tr>
+				<td>GET</td>
+                                <td><b>/nodes/{$node_id}/get_name</b></td>
+                                <td>Get the name of the node $node_id </td>
+                        </tr>
+                        <tr>
+				<td>GET</td>
+                                <td><b>/nodes/{$node_id}/get_location</b></td>
+                                <td>Get the location of the node $node_id </td>
+                        </tr>
+        </table>
+
+
+
+
+
+
+		<h2>Sensors Endpoints (Multisensors)</h2>
+		<table>
+			<tr>
+				<th>Method</th>
+				<th>Routes</th>
+				<th>Description</th>
+			</tr>
+			<tr>   
+				<td>GET</td>
+				<td><b><a href="/sensors/get_sensors_list">/sensors/get_sensors_list</a></b></td>
+				<td>Display the list of all sensors in the network</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/sensors/{$sensor_id}/get_all_measures</b></td>
+				<td>Return all measures (temp, hum, lum, motion ...) for sensor $sensor_id</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/sensors/{$sensor_id}/get_temperature</b></td>
+				<td>Return current temperature for sensor $sensor_id</td>
+			</tr>
+			<tr>	
+				<td>GET</td>
+				<td><b>/sensors/{$sensor_id}/get_humidity</b></td>
+				<td>Return current humidity for sensor $sensor_id</td>
+			</tr>
+			<tr>		
+				<td>GET</td>
+				<td><b>/sensors/{$sensor_id}/get_luminance</b></td>
+				<td>Return current luminance for sensor $sensor_id</td>
+			</tr>
+			<tr>	
+				<td>GET</td>
+				<td><b>/sensors/{$sensor_id}/get_motion</b></td>
+				<td>Return presence detection value for sensor $sensor_id</td>
+			</tr>
+
+        </table>
+
+
+
+
+
+		<h2>Actuators Endpoints </h2>
+		<table>
+			<tr>
+				<th>Method</th>
+				<th>Routes</th>
+				<th>Description</th>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b><a href="/dimmers/get_dimmers_list">/dimmers/get_dimmers_list</a></b></td>
+				<td>Lists all dimmer nodes in the network.</td>
+			</tr>
+			<tr>
+				<td>GET</td>
+				<td><b>/dimmers/{$dimmer_id}/get_level</a></b></td>
+				<td>Gets dimmer node's brightness level</td>
+			</tr>
+			<tr>
+				<td style="color: red;">POST</td>
+				<td><b>/dimmers/{$dimmer_id}/set_level</b></td>
+				<td>Sends command to dimmer node to set its brightness level</td>
+			</tr>
+
+        </table>		
+		
+
+		
+        <br/><br/>
+        JSON format :<br/>
+        <span>{<br/>
+        &nbsp;&nbsp;"controller": CONTROLLER_NAME,<br/>
+        &nbsp;&nbsp;"location": SENSOR_LOCATION, <br/>
+        &nbsp;&nbsp;"sensor": SENSOR_ID,<br/>
+        &nbsp;&nbsp;"type": SENSOR_TYPE, <br/>
+        &nbsp;&nbsp;"updateTime": TIMESTAMP,<br/> 
+        &nbsp;&nbsp;"value": SENSOR_VALUE<br/>
+        }<br/><br/></span>
+        
+        Fields description :<br/>
+        <span>
+        &nbsp;&nbsp;<b>controller</b> : String desribing the controller (Raspberry name)<br/>
+        &nbsp;&nbsp;<b>location</b> : Precise location of the sensor in his network<br/>
+        &nbsp;&nbsp;<b>sensor</b> : Value describing the sensor (integer value)<br/>
+        &nbsp;&nbsp;<b>type</b> : String describing the sensor, possible values : <i>"temperature", "humidity", "presence", "luminosity"</i><br/>
+        &nbsp;&nbsp;<b>updateTime</b> : Timestamp of last update <br/>
+        &nbsp;&nbsp;<b>value</b> : Value of the sensor, possible types : <i>float</i> for temperature(deg. celsius), humidity(%age) and luminosity(lux) ; <i>boolea$
+        </span>
+	</body>
+</html>