Skip to content

Commit 79962d8

Browse files
jburhennjburhenn
committed
Add new datatypes module.
1 parent a3de96a commit 79962d8

File tree

4 files changed

+86
-77
lines changed

4 files changed

+86
-77
lines changed

‎cayenne/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "1.0.1"
1+
__version__ = "1.0.2a1"

‎cayenne/client.py‎

Lines changed: 6 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,12 @@
1+
"""
2+
This module contains the main agent client for connecting to the Cayenne server. The client connects
3+
to server, sends data to the server and handles commands from the server.
4+
"""
5+
16
import time
27
import paho.mqtt.client as mqtt
38
from cayenne import __version__
4-
5-
6-
# Data types
7-
TYPE_ACCELERATION = 'accel' # Acceleration, units: UNIT_G
8-
TYPE_ANALOG_ACTUATOR = 'analog_actuator' # Analog Actuator, units: UNIT_ANALOG
9-
TYPE_ANALOG_SENSOR = 'analog_sensor' # Analog Sensor, units: UNIT_ANALOG
10-
TYPE_BAROMETRIC_PRESSURE = 'bp' # Barometric pressure, units: UNIT_PASCAL, UNIT_HECTOPASCAL
11-
TYPE_BATTERY = 'batt' # Battery, units: UNIT_PERCENT, UNIT_RATIO, UNIT_VOLTS
12-
TYPE_CO2 = 'co2' # Carbon Dioxide, units: UNIT_PPM
13-
TYPE_COUNTER = 'counter' # Counter, units: UNIT_ANALOG
14-
TYPE_CURRENT = 'current' # Current, units: UNIT_AMP, UNIT_MAMP
15-
TYPE_DIGITAL_ACTUATOR = 'digital_actuator' # Digital Actuator, units: UNIT_DIGITAL
16-
TYPE_DIGITAL_SENSOR = 'digital_sensor' # Digital Sensor, units: UNIT_DIGITAL
17-
TYPE_ENERGY = 'energy' # Energy, units: UNIT_KWH
18-
TYPE_EXT_WATERLEAK = 'ext_wleak' # External Waterleak, units: UNIT_ANALOG
19-
TYPE_FREQUENCY = 'freq' # Frequency, units: UNIT_HERTZ
20-
TYPE_GPS = 'gps' # GPS, units: UNIT_GPS
21-
TYPE_GYROSCOPE = 'gyro' # Gyroscope, units: UNIT_ROTATION_PER_MINUTE, UNIT_DEGREE_PER_SEC
22-
TYPE_LUMINOSITY = 'lum' # Luminosity, units: UNIT_LUX, UNIT_VOLTS, UNIT_PERCENT, UNIT_RATIO
23-
TYPE_MOTION = 'motion' # Motion, units: UNIT_DIGITAL
24-
TYPE_POWER = 'pow' # Power, units: UNIT_WATT, UNIT_KILOWATT
25-
TYPE_PROXIMITY = 'prox' # Proximity, units: UNIT_CENTIMETER, UNIT_METER, UNIT_DIGITAL
26-
TYPE_RAIN_LEVEL = 'rain_level' # Rain Level, units: UNIT_CENTIMETER, UNIT_MILLIMETER
27-
TYPE_RELATIVE_HUMIDITY = 'rel_hum' # Relative Humidity, units: UNIT_PERCENT, UNIT_RATIO
28-
TYPE_RESISTANCE = 'res' # Resistance, units: UNIT_OHM
29-
TYPE_RSSI = 'rssi' # Received signal strength indicator, units: UNIT_DBM
30-
TYPE_SNR = 'snr' # Signal Noise Ratio, units: UNIT_DB
31-
TYPE_SOIL_MOISTURE = 'soil_moist' # Soil Moisture, units: UNIT_PERCENT
32-
TYPE_SOIL_PH = 'soil_ph' # Soil pH, units: UNIT_ANALOG
33-
TYPE_SOIL_WATER_TENSION = 'soil_w_ten' # Soil Water Tension, units: UNIT_KILOPASCAL, UNIT_PASCAL
34-
TYPE_TANK_LEVEL = 'tl' # Tank Level, units: UNIT_ANALOG
35-
TYPE_TEMPERATURE = 'temp' # Temperature, units: UNIT_FAHRENHEIT, UNIT_CELSIUS, UNIT_KELVIN
36-
TYPE_VOLTAGE = 'voltage' # Voltage, units: UNIT_VOLTS, UNIT_MILLIVOLTS
37-
TYPE_WIND_SPEED = 'wind_speed' # Wind Speed, units: UNIT_KM_PER_H
38-
39-
# Unit types
40-
UNIT_UNDEFINED = 'null' # Undefined unit type
41-
UNIT_AMP = 'a' # Ampere
42-
UNIT_ANALOG = 'null' # Analog
43-
UNIT_CELSIUS = 'c' # Celsius
44-
UNIT_CENTIMETER = 'cm' # Centimeter
45-
UNIT_DB = 'db' # Decibels
46-
UNIT_DBM = 'dbm' # dBm
47-
UNIT_DEGREE_PER_SEC = 'dps' # Degree per second
48-
UNIT_DIGITAL = 'd' # Digital (0/1)
49-
UNIT_FAHRENHEIT = 'f' # Fahrenheit
50-
UNIT_G = 'g' # Acceleration
51-
UNIT_GPS = 'm' # GPS
52-
UNIT_HECTOPASCAL = 'hpa' # Hectopascal
53-
UNIT_HERTZ = 'hz' # Hertz
54-
UNIT_KELVIN = 'k' # Kelvin
55-
UNIT_KILOPASCAL = 'kpa' # Kilopascal
56-
UNIT_KILOWATT = 'kw' # Kilowatts
57-
UNIT_KM_PER_H = 'kmh' # Kilometer per hour
58-
UNIT_KWH = 'kwh' # Killowatt Hour
59-
UNIT_LUX = 'lux' # Lux
60-
UNIT_MAMP = 'ma' # Milliampere
61-
UNIT_METER = 'm' # Meter
62-
UNIT_MILLIMETER = 'mm' # Millimeter
63-
UNIT_MILLIVOLTS = 'mv' # Millivolts
64-
UNIT_OHM = 'ohm' # Ohm
65-
UNIT_PASCAL = 'pa' # Pascal
66-
UNIT_PERCENT = 'p' # Percent (%)
67-
UNIT_PPM = 'ppm' # Parts per million
68-
UNIT_RATIO = 'r' # Ratio
69-
UNIT_ROTATION_PER_MINUTE = 'rpm' # Rotation per minute
70-
UNIT_VOLTS = 'v' # Volts
71-
UNIT_WATT = 'w' # Watts
9+
from cayenne.datatypes import *
7210

7311
# Topics
7412
COMMAND_TOPIC = "cmd"

‎cayenne/datatypes.py‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
"""
2+
This module contains the data types used when sending data to the Cayenne server.
3+
"""
4+
5+
# Data types
6+
TYPE_ACCELERATION = 'accel' # Acceleration, units: UNIT_G
7+
TYPE_ANALOG_ACTUATOR = 'analog_actuator' # Analog Actuator, units: UNIT_ANALOG
8+
TYPE_ANALOG_SENSOR = 'analog_sensor' # Analog Sensor, units: UNIT_ANALOG
9+
TYPE_BAROMETRIC_PRESSURE = 'bp' # Barometric pressure, units: UNIT_PASCAL, UNIT_HECTOPASCAL
10+
TYPE_BATTERY = 'batt' # Battery, units: UNIT_PERCENT, UNIT_RATIO, UNIT_VOLTS
11+
TYPE_CO2 = 'co2' # Carbon Dioxide, units: UNIT_PPM
12+
TYPE_COUNTER = 'counter' # Counter, units: UNIT_ANALOG
13+
TYPE_CURRENT = 'current' # Current, units: UNIT_AMP, UNIT_MAMP
14+
TYPE_DIGITAL_ACTUATOR = 'digital_actuator' # Digital Actuator, units: UNIT_DIGITAL
15+
TYPE_DIGITAL_SENSOR = 'digital_sensor' # Digital Sensor, units: UNIT_DIGITAL
16+
TYPE_ENERGY = 'energy' # Energy, units: UNIT_KWH
17+
TYPE_EXT_WATERLEAK = 'ext_wleak' # External Waterleak, units: UNIT_ANALOG
18+
TYPE_FREQUENCY = 'freq' # Frequency, units: UNIT_HERTZ
19+
TYPE_GPS = 'gps' # GPS, units: UNIT_GPS
20+
TYPE_GYROSCOPE = 'gyro' # Gyroscope, units: UNIT_ROTATION_PER_MINUTE, UNIT_DEGREE_PER_SEC
21+
TYPE_LUMINOSITY = 'lum' # Luminosity, units: UNIT_LUX, UNIT_VOLTS, UNIT_PERCENT, UNIT_RATIO
22+
TYPE_MOTION = 'motion' # Motion, units: UNIT_DIGITAL
23+
TYPE_POWER = 'pow' # Power, units: UNIT_WATT, UNIT_KILOWATT
24+
TYPE_PROXIMITY = 'prox' # Proximity, units: UNIT_CENTIMETER, UNIT_METER, UNIT_DIGITAL
25+
TYPE_RAIN_LEVEL = 'rain_level' # Rain Level, units: UNIT_CENTIMETER, UNIT_MILLIMETER
26+
TYPE_RELATIVE_HUMIDITY = 'rel_hum' # Relative Humidity, units: UNIT_PERCENT, UNIT_RATIO
27+
TYPE_RESISTANCE = 'res' # Resistance, units: UNIT_OHM
28+
TYPE_RSSI = 'rssi' # Received signal strength indicator, units: UNIT_DBM
29+
TYPE_SNR = 'snr' # Signal Noise Ratio, units: UNIT_DB
30+
TYPE_SOIL_MOISTURE = 'soil_moist' # Soil Moisture, units: UNIT_PERCENT
31+
TYPE_SOIL_PH = 'soil_ph' # Soil pH, units: UNIT_ANALOG
32+
TYPE_SOIL_WATER_TENSION = 'soil_w_ten' # Soil Water Tension, units: UNIT_KILOPASCAL, UNIT_PASCAL
33+
TYPE_TANK_LEVEL = 'tl' # Tank Level, units: UNIT_ANALOG
34+
TYPE_TEMPERATURE = 'temp' # Temperature, units: UNIT_FAHRENHEIT, UNIT_CELSIUS, UNIT_KELVIN
35+
TYPE_VOLTAGE = 'voltage' # Voltage, units: UNIT_VOLTS, UNIT_MILLIVOLTS
36+
TYPE_WIND_SPEED = 'wind_speed' # Wind Speed, units: UNIT_KM_PER_H
37+
38+
# Unit types
39+
UNIT_UNDEFINED = 'null' # Undefined unit type
40+
UNIT_AMP = 'a' # Ampere
41+
UNIT_ANALOG = 'null' # Analog
42+
UNIT_CELSIUS = 'c' # Celsius
43+
UNIT_CENTIMETER = 'cm' # Centimeter
44+
UNIT_DB = 'db' # Decibels
45+
UNIT_DBM = 'dbm' # dBm
46+
UNIT_DEGREE_PER_SEC = 'dps' # Degree per second
47+
UNIT_DIGITAL = 'd' # Digital (0/1)
48+
UNIT_FAHRENHEIT = 'f' # Fahrenheit
49+
UNIT_G = 'g' # Acceleration
50+
UNIT_GPS = 'm' # GPS
51+
UNIT_HECTOPASCAL = 'hpa' # Hectopascal
52+
UNIT_HERTZ = 'hz' # Hertz
53+
UNIT_KELVIN = 'k' # Kelvin
54+
UNIT_KILOPASCAL = 'kpa' # Kilopascal
55+
UNIT_KILOWATT = 'kw' # Kilowatts
56+
UNIT_KM_PER_H = 'kmh' # Kilometer per hour
57+
UNIT_KWH = 'kwh' # Killowatt Hour
58+
UNIT_LUX = 'lux' # Lux
59+
UNIT_MAMP = 'ma' # Milliampere
60+
UNIT_METER = 'm' # Meter
61+
UNIT_MILLIMETER = 'mm' # Millimeter
62+
UNIT_MILLIVOLTS = 'mv' # Millivolts
63+
UNIT_OHM = 'ohm' # Ohm
64+
UNIT_PASCAL = 'pa' # Pascal
65+
UNIT_PERCENT = 'p' # Percent (%)
66+
UNIT_PPM = 'ppm' # Parts per million
67+
UNIT_RATIO = 'r' # Ratio
68+
UNIT_ROTATION_PER_MINUTE = 'rpm' # Rotation per minute
69+
UNIT_VOLTS = 'v' # Volts
70+
UNIT_WATT = 'w' # Watts

‎examples/Example-03-CayenneClient.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env python
2-
import cayenne.client
2+
from cayenne import client, datatypes
33
import time
44

55
# Cayenne authentication info. This should be obtained from the Cayenne Dashboard.
@@ -13,19 +13,20 @@ def on_message(message):
1313
print("message received: " + str(message))
1414
# If there is an error processing the message return an error string, otherwise return nothing.
1515

16-
client = cayenne.client.CayenneMQTTClient()
17-
client.on_message = on_message
18-
client.begin(MQTT_USERNAME, MQTT_PASSWORD, MQTT_CLIENT_ID)
16+
cayenne_client = client.CayenneMQTTClient()
17+
cayenne_client.on_message = on_message
18+
cayenne_client.begin(MQTT_USERNAME, MQTT_PASSWORD, MQTT_CLIENT_ID)
1919

2020
i=0
2121
timestamp = 0
2222

2323
while True:
24-
client.loop()
24+
cayenne_client.loop()
2525

2626
if (time.time() > timestamp + 10):
27-
client.celsiusWrite(1, i)
28-
client.luxWrite(2, i*10)
29-
client.hectoPascalWrite(3, i+800)
27+
cayenne_client.celsiusWrite(1, i)
28+
cayenne_client.luxWrite(2, i*10)
29+
cayenne_client.hectoPascalWrite(3, i+800)
30+
cayenne_client.virtualWrite(4, i%2, datatypes.TYPE_DIGITAL_SENSOR, datatypes.UNIT_DIGITAL)
3031
timestamp = time.time()
3132
i = i+1

0 commit comments

Comments
 (0)