Merge pull request #5 from myDevicesIoT/feature/multivalue

Add new data types and units.

Author: jburhenn

cayenne/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.1"
+__version__ = "1.0.2a1"

cayenne/client.py

@@ -1,31 +1,12 @@
-import paho.mqtt.client as mqtt
+"""
+This module contains the main agent client for connecting to the Cayenne server. The client connects
+to server, sends data to the server and handles commands from the server.
+"""
+
 import time
+import paho.mqtt.client as mqtt
 from cayenne import __version__
-
-# Data types
-TYPE_BAROMETRIC_PRESSURE = "bp" # Barometric pressure
-TYPE_BATTERY = "batt" # Battery
-TYPE_LUMINOSITY = "lum" # Luminosity
-TYPE_PROXIMITY = "prox" # Proximity
-TYPE_RELATIVE_HUMIDITY = "rel_hum" # Relative Humidity
-TYPE_TEMPERATURE = "temp" # Temperature
-TYPE_VOLTAGE = "voltage" # Voltage
-
-# Unit types
-UNIT_UNDEFINED = "null"
-UNIT_PASCAL = "pa" # Pascal
-UNIT_HECTOPASCAL = "hpa" # Hectopascal
-UNIT_PERCENT = "p" # % (0 to 100)
-UNIT_RATIO = "r" # Ratio
-UNIT_VOLTS = "v" # Volts
-UNIT_LUX = "lux" # Lux
-UNIT_CENTIMETER = "cm" # Centimeter
-UNIT_METER = "m" # Meter
-UNIT_DIGITAL = "d" # Digital (0/1)
-UNIT_FAHRENHEIT = "f" # Fahrenheit
-UNIT_CELSIUS = "c" # Celsius
-UNIT_KELVIN = "k" # Kelvin
-UNIT_MILLIVOLTS = "mv" # Millivolts
+from cayenne.datatypes import *
 
 # Topics
 COMMAND_TOPIC = "cmd"
@@ -52,7 +33,7 @@ def on_connect(client, cayenne, flags, rc):
         # reconnect then subscriptions will be renewed.
         cayenne.connected = True
         cayenne.reconnect = False
-        command_topic = cayenne.getCommandTopic();
+        command_topic = cayenne.getCommandTopic()
         print("SUB %s\n" % command_topic)
         client.subscribe(command_topic)
         cayenne.mqttPublish("%s/sys/model" % cayenne.rootTopic, "Python")
@@ -255,6 +236,30 @@ def hectoPascalWrite(self, channel, value):
         """
         self.virtualWrite(channel, value, TYPE_BAROMETRIC_PRESSURE, UNIT_HECTOPASCAL)
 
+    def accelWrite(self, channel, x=UNIT_UNDEFINED, y=UNIT_UNDEFINED, z=UNIT_UNDEFINED):
+        """Send an acceleration value list to Cayenne.
+
+        channel is the Cayenne channel to use.
+        x is the acceleration on the X-axis.
+        y is the acceleration on the Y-axis.
+        z is the acceleration on the Z-axis.
+        """
+        value = [x, y, z]
+        value = ''.join(c for c in repr(value) if c not in (" ", "'"))
+        self.virtualWrite(channel, value, TYPE_ACCELERATION, UNIT_G)
+
+    def gpsWrite(self, channel, latitude=UNIT_UNDEFINED, longitude=UNIT_UNDEFINED, altitude=UNIT_UNDEFINED):
+        """Send a GPS value list to Cayenne.
+
+        channel is the Cayenne channel to use.
+        latitude is the latitude in degrees.
+        longitude is the longitude in degrees.
+        altitude is the altitude in meters.
+        """
+        value = [latitude, longitude, altitude]
+        value = ''.join(c for c in repr(value) if c not in (" ", "'"))
+        self.virtualWrite(channel, value, TYPE_GPS, UNIT_METER)
+
     def mqttPublish(self, topic, payload):
         """Publish a payload to a topic
         

cayenne/datatypes.py

@@ -0,0 +1,70 @@
+"""
+This module contains the data types used when sending data to the Cayenne server.
+"""
+
+# Data types
+TYPE_ACCELERATION = 'accel' # Acceleration, units: UNIT_G
+TYPE_ANALOG_ACTUATOR = 'analog_actuator' # Analog Actuator, units: UNIT_ANALOG
+TYPE_ANALOG_SENSOR = 'analog_sensor' # Analog Sensor, units: UNIT_ANALOG
+TYPE_BAROMETRIC_PRESSURE = 'bp' # Barometric pressure, units: UNIT_PASCAL, UNIT_HECTOPASCAL
+TYPE_BATTERY = 'batt' # Battery, units: UNIT_PERCENT, UNIT_RATIO, UNIT_VOLTS
+TYPE_CO2 = 'co2' # Carbon Dioxide, units: UNIT_PPM
+TYPE_COUNTER = 'counter' # Counter, units: UNIT_ANALOG
+TYPE_CURRENT = 'current' # Current, units: UNIT_AMP, UNIT_MAMP
+TYPE_DIGITAL_ACTUATOR = 'digital_actuator' # Digital Actuator, units: UNIT_DIGITAL
+TYPE_DIGITAL_SENSOR = 'digital_sensor' # Digital Sensor, units: UNIT_DIGITAL
+TYPE_ENERGY = 'energy' # Energy, units: UNIT_KWH
+TYPE_EXT_WATERLEAK = 'ext_wleak' # External Waterleak, units: UNIT_ANALOG
+TYPE_FREQUENCY = 'freq' # Frequency, units: UNIT_HERTZ
+TYPE_GPS = 'gps' # GPS, units: UNIT_GPS
+TYPE_GYROSCOPE = 'gyro' # Gyroscope, units: UNIT_ROTATION_PER_MINUTE, UNIT_DEGREE_PER_SEC
+TYPE_LUMINOSITY = 'lum' # Luminosity, units: UNIT_LUX, UNIT_VOLTS, UNIT_PERCENT, UNIT_RATIO
+TYPE_MOTION = 'motion' # Motion, units: UNIT_DIGITAL
+TYPE_POWER = 'pow' # Power, units: UNIT_WATT, UNIT_KILOWATT
+TYPE_PROXIMITY = 'prox' # Proximity, units: UNIT_CENTIMETER, UNIT_METER, UNIT_DIGITAL
+TYPE_RAIN_LEVEL = 'rain_level' # Rain Level, units: UNIT_CENTIMETER, UNIT_MILLIMETER
+TYPE_RELATIVE_HUMIDITY = 'rel_hum' # Relative Humidity, units: UNIT_PERCENT, UNIT_RATIO
+TYPE_RESISTANCE = 'res' # Resistance, units: UNIT_OHM
+TYPE_RSSI = 'rssi' # Received signal strength indicator, units: UNIT_DBM
+TYPE_SNR = 'snr' # Signal Noise Ratio, units: UNIT_DB
+TYPE_SOIL_MOISTURE = 'soil_moist' # Soil Moisture, units: UNIT_PERCENT
+TYPE_SOIL_PH = 'soil_ph' # Soil pH, units: UNIT_ANALOG
+TYPE_SOIL_WATER_TENSION = 'soil_w_ten' # Soil Water Tension, units: UNIT_KILOPASCAL, UNIT_PASCAL
+TYPE_TANK_LEVEL = 'tl' # Tank Level, units: UNIT_ANALOG
+TYPE_TEMPERATURE = 'temp' # Temperature, units: UNIT_FAHRENHEIT, UNIT_CELSIUS, UNIT_KELVIN
+TYPE_VOLTAGE = 'voltage' # Voltage, units: UNIT_VOLTS, UNIT_MILLIVOLTS
+TYPE_WIND_SPEED = 'wind_speed' # Wind Speed, units: UNIT_KM_PER_H
+
+# Unit types
+UNIT_UNDEFINED = 'null' # Undefined unit type
+UNIT_AMP = 'a' # Ampere
+UNIT_ANALOG = 'null' # Analog
+UNIT_CELSIUS = 'c' # Celsius
+UNIT_CENTIMETER = 'cm' # Centimeter
+UNIT_DB = 'db' # Decibels
+UNIT_DBM = 'dbm' # dBm
+UNIT_DEGREE_PER_SEC = 'dps' # Degree per second
+UNIT_DIGITAL = 'd' # Digital (0/1)
+UNIT_FAHRENHEIT = 'f' # Fahrenheit
+UNIT_G = 'g' # Acceleration
+UNIT_GPS = 'm' # GPS
+UNIT_HECTOPASCAL = 'hpa' # Hectopascal
+UNIT_HERTZ = 'hz' # Hertz
+UNIT_KELVIN = 'k' # Kelvin
+UNIT_KILOPASCAL = 'kpa' # Kilopascal
+UNIT_KILOWATT = 'kw' # Kilowatts
+UNIT_KM_PER_H = 'kmh' # Kilometer per hour
+UNIT_KWH = 'kwh' # Killowatt Hour
+UNIT_LUX = 'lux' # Lux
+UNIT_MAMP = 'ma' # Milliampere
+UNIT_METER = 'm' # Meter
+UNIT_MILLIMETER = 'mm' # Millimeter
+UNIT_MILLIVOLTS = 'mv' # Millivolts
+UNIT_OHM = 'ohm' # Ohm
+UNIT_PASCAL = 'pa' # Pascal
+UNIT_PERCENT = 'p' # Percent (%)
+UNIT_PPM = 'ppm' # Parts per million
+UNIT_RATIO = 'r' # Ratio
+UNIT_ROTATION_PER_MINUTE = 'rpm' # Rotation per minute
+UNIT_VOLTS = 'v' # Volts
+UNIT_WATT = 'w' # Watts

examples/Example-03-CayenneClient.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-import cayenne.client
+from cayenne import client, datatypes
 import time
 
 # Cayenne authentication info. This should be obtained from the Cayenne Dashboard.
@@ -13,19 +13,20 @@ def on_message(message):
     print("message received: " + str(message))
     # If there is an error processing the message return an error string, otherwise return nothing.
 
-client = cayenne.client.CayenneMQTTClient()
-client.on_message = on_message
-client.begin(MQTT_USERNAME, MQTT_PASSWORD, MQTT_CLIENT_ID)
+cayenne_client = client.CayenneMQTTClient()
+cayenne_client.on_message = on_message
+cayenne_client.begin(MQTT_USERNAME, MQTT_PASSWORD, MQTT_CLIENT_ID)
 
 i=0
 timestamp = 0
 
 while True:
-    client.loop()
+    cayenne_client.loop()
 
     if (time.time() > timestamp + 10):
-        client.celsiusWrite(1, i)
-        client.luxWrite(2, i*10)
-        client.hectoPascalWrite(3, i+800)
+        cayenne_client.celsiusWrite(1, i)
+        cayenne_client.luxWrite(2, i*10)
+        cayenne_client.hectoPascalWrite(3, i+800)
+        cayenne_client.virtualWrite(4, i%2, datatypes.TYPE_DIGITAL_SENSOR, datatypes.UNIT_DIGITAL)
         timestamp = time.time()
         i = i+1

tests/Test-01-TestClient.py

@@ -43,6 +43,8 @@ def on_message(message):
     client.luxWrite(4, 4)
     client.pascalWrite(5, 5)
     client.hectoPascalWrite(6, 6)
+    client.accelWrite(7, 7.01, 7.02, -7.03)
+    client.gpsWrite(8, 27.986065, 86.922623, 8848)
 
     print("Test receiving commands")
     client.mqttPublish(client.rootTopic + '/cmd/10', 'senderror,0')