#ifndef MySensors_h #define MySensors_h #include #include void rs485_in(void); void rs485_out(void); typedef unsigned char uint8_t; typedef unsigned int uint16_t; typedef unsigned long uint32_t; typedef signed int int16_t; typedef signed long int32_t; #define MY_LIBRARY_VERSION "NUVO 1.0" #define GATEWAY_ADDRESS ((uint8_t)0) //!< Node ID for GW sketch //#define MY_NODE_ID ((uint8_t)201) #define NODE_SENSOR_ID ((uint8_t)255) //!< Node child is always created/presented when a node is started #define MY_CORE_VERSION ((uint8_t)2) //!< core version #define MY_CORE_MIN_VERSION ((uint8_t)2) //!< min core version required for compatibility #define V2_MYS_HEADER_PROTOCOL_VERSION (2u) //!< Protocol version #define V2_MYS_HEADER_SIZE (7u) //!< Header size #define V2_MYS_HEADER_MAX_MESSAGE_SIZE (32u) //!< Max payload size #define V2_MYS_HEADER_VSL_VERSION_POS (0) //!< bitfield position version #define V2_MYS_HEADER_VSL_VERSION_SIZE (2u) //!< size version field #define V2_MYS_HEADER_VSL_SIGNED_POS (2u) //!< bitfield position signed field #define V2_MYS_HEADER_VSL_SIGNED_SIZE (1u) //!< size signed field #define V2_MYS_HEADER_VSL_LENGTH_POS (3u) //!< bitfield position length field #define V2_MYS_HEADER_VSL_LENGTH_SIZE (5u) //!< size length field #define V2_MYS_HEADER_CEP_COMMAND_POS (0) //!< bitfield position command field #define V2_MYS_HEADER_CEP_COMMAND_SIZE (3u) //!< size command field #define V2_MYS_HEADER_CEP_ECHOREQUEST_POS (3u) //!< bitfield position echo request field #define V2_MYS_HEADER_CEP_ECHOREQUEST_SIZE (1u) //!< size echo request field #define V2_MYS_HEADER_CEP_ECHO_POS (4u) //!< bitfield position echo field #define V2_MYS_HEADER_CEP_ECHO_SIZE (1u) //!< size echo field #define V2_MYS_HEADER_CEP_PAYLOADTYPE_POS (5u) //!< bitfield position payload type field #define V2_MYS_HEADER_CEP_PAYLOADTYPE_SIZE (3u) //!< size payload type field #define MAX_MESSAGE_SIZE V2_MYS_HEADER_MAX_MESSAGE_SIZE //!< The maximum size of a message (including header) #define HEADER_SIZE V2_MYS_HEADER_SIZE //!< The size of the header #define MAX_PAYLOAD_SIZE (MAX_MESSAGE_SIZE - HEADER_SIZE) //!< The maximum size of a payload depends on #MAX_MESSAGE_SIZE and #HEADER_SIZE #define MY_RS485_MAX_MESSAGE_LENGTH MAX_MESSAGE_SIZE #define MY_RS485_SOH_COUNT 1 #define MY_CAP_RESET "N" #define MY_CAP_OTA_FW "N" #define MY_CAP_RADIO "S" #define MY_CAP_TYPE "N" #define MY_CAP_ARCH "F" #define MY_CAP_SIGN "-" #define MY_CAP_RXBUF "-" #define MY_CAP_ENCR "-" #define MY_CAPABILITIES MY_CAP_RESET MY_CAP_RADIO MY_CAP_OTA_FW MY_CAP_TYPE MY_CAP_ARCH MY_CAP_SIGN MY_CAP_RXBUF MY_CAP_ENCR #define MY_TRANSPORT_MAX_TX_FAILURES (10u) //!< search for a new parent node after this many transmission failures, higher threshold for repeating nodes #define MY_TRANSPORT_MAX_TSM_FAILURES (7u) //!< Max. number of consecutive TSM failure state entries (3bits) #define MY_TRANSPORT_TIMEOUT_EXT_FAILURE_STATE_MS (60*1000ul) //!< Duration extended failure state (in ms) #define MY_TRANSPORT_STATE_TIMEOUT_MS (2*1000ul) //!< general state timeout (in ms) #define MY_TRANSPORT_CHKUPL_INTERVAL_MS (10*1000ul) //!< Interval to re-check uplink (in ms) #define MY_TRANSPORT_STATE_RETRIES (3u) //!< retries before switching to FAILURE #define BROADCAST_ADDRESS (255u) //!< broadcasts are addressed to ID 255 #define MAX_SUBSEQ_MSGS (5u) //!< Maximum number of subsequently processed messages in FIFO (to prevent transport deadlock if HW issue) /** * @brief Node core configuration */ /// @brief The command field (message-type) defines the overall properties of a message typedef enum { C_PRESENTATION = 0, //!< Sent by a node when they present attached sensors. This is usually done in presentation() at startup. C_SET = 1, //!< This message is sent from or to a sensor when a sensor value should be updated. C_REQ = 2, //!< Requests a variable value (usually from an actuator destined for controller). C_INTERNAL = 3, //!< Internal MySensors messages (also include common messages provided/generated by the library). C_STREAM = 4, //!< For firmware and other larger chunks of data that need to be divided into pieces. C_RESERVED_5 = 5, //!< C_RESERVED_5 C_RESERVED_6 = 6, //!< C_RESERVED_6 C_INVALID_7 = 7 //!< C_INVALID_7 } mysensors_command_t; /// @brief Type of sensor (used when presenting sensors) typedef enum { S_DOOR = 0, //!< Door sensor, V_TRIPPED, V_ARMED S_MOTION = 1, //!< Motion sensor, V_TRIPPED, V_ARMED S_SMOKE = 2, //!< Smoke sensor, V_TRIPPED, V_ARMED S_BINARY = 3, //!< Binary light or relay, V_STATUS, V_WATT S_LIGHT = 3, //!< \deprecated Same as S_BINARY S_DIMMER = 4, //!< Dimmable light or fan device, V_STATUS (on/off), V_PERCENTAGE (dimmer level 0-100), V_WATT S_COVER = 5, //!< Blinds or window cover, V_UP, V_DOWN, V_STOP, V_PERCENTAGE (open/close to a percentage) S_TEMP = 6, //!< Temperature sensor, V_TEMP S_HUM = 7, //!< Humidity sensor, V_HUM S_BARO = 8, //!< Barometer sensor, V_PRESSURE, V_FORECAST S_WIND = 9, //!< Wind sensor, V_WIND, V_GUST S_RAIN = 10, //!< Rain sensor, V_RAIN, V_RAINRATE S_UV = 11, //!< Uv sensor, V_UV S_WEIGHT = 12, //!< Personal scale sensor, V_WEIGHT, V_IMPEDANCE S_POWER = 13, //!< Power meter, V_WATT, V_KWH, V_VAR, V_VA, V_POWER_FACTOR S_HEATER = 14, //!< Header device, V_HVAC_SETPOINT_HEAT, V_HVAC_FLOW_STATE, V_TEMP S_DISTANCE = 15, //!< Distance sensor, V_DISTANCE S_LIGHT_LEVEL = 16, //!< Light level sensor, V_LIGHT_LEVEL (uncalibrated in percentage), V_LEVEL (light level in lux) S_ARDUINO_NODE = 17, //!< Used (internally) for presenting a non-repeating Arduino node S_ARDUINO_REPEATER_NODE = 18, //!< Used (internally) for presenting a repeating Arduino node S_LOCK = 19, //!< Lock device, V_LOCK_STATUS S_IR = 20, //!< IR device, V_IR_SEND, V_IR_RECEIVE S_WATER = 21, //!< Water meter, V_FLOW, V_VOLUME S_AIR_QUALITY = 22, //!< Air quality sensor, V_LEVEL S_CUSTOM = 23, //!< Custom sensor S_DUST = 24, //!< Dust sensor, V_LEVEL S_SCENE_CONTROLLER = 25, //!< Scene controller device, V_SCENE_ON, V_SCENE_OFF. S_RGB_LIGHT = 26, //!< RGB light. Send color component data using V_RGB. Also supports V_WATT S_RGBW_LIGHT = 27, //!< RGB light with an additional White component. Send data using V_RGBW. Also supports V_WATT S_COLOR_SENSOR = 28, //!< Color sensor, send color information using V_RGB S_HVAC = 29, //!< Thermostat/HVAC device. V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COLD, V_HVAC_FLOW_STATE, V_HVAC_FLOW_MODE, V_TEMP S_MULTIMETER = 30, //!< Multimeter device, V_VOLTAGE, V_CURRENT, V_IMPEDANCE S_SPRINKLER = 31, //!< Sprinkler, V_STATUS (turn on/off), V_TRIPPED (if fire detecting device) S_WATER_LEAK = 32, //!< Water leak sensor, V_TRIPPED, V_ARMED S_SOUND = 33, //!< Sound sensor, V_TRIPPED, V_ARMED, V_LEVEL (sound level in dB) S_VIBRATION = 34, //!< Vibration sensor, V_TRIPPED, V_ARMED, V_LEVEL (vibration in Hz) S_MOISTURE = 35, //!< Moisture sensor, V_TRIPPED, V_ARMED, V_LEVEL (water content or moisture in percentage?) S_INFO = 36, //!< LCD text device / Simple information device on controller, V_TEXT S_GAS = 37, //!< Gas meter, V_FLOW, V_VOLUME S_GPS = 38, //!< GPS Sensor, V_POSITION S_WATER_QUALITY = 39 //!< V_TEMP, V_PH, V_ORP, V_EC, V_STATUS } mysensors_sensor_t; /// @brief Type of sensor data (for set/req/echo messages) typedef enum { V_TEMP = 0, //!< S_TEMP. Temperature S_TEMP, S_HEATER, S_HVAC V_HUM = 1, //!< S_HUM. Humidity V_STATUS = 2, //!< S_BINARY, S_DIMMER, S_SPRINKLER, S_HVAC, S_HEATER. Used for setting/reporting binary (on/off) status. 1=on, 0=off V_LIGHT = 2, //!< \deprecated Same as V_STATUS V_PERCENTAGE = 3, //!< S_DIMMER. Used for sending a percentage value 0-100 (%). V_DIMMER = 3, //!< \deprecated Same as V_PERCENTAGE V_PRESSURE = 4, //!< S_BARO. Atmospheric Pressure V_FORECAST = 5, //!< S_BARO. Whether forecast. string of "stable", "sunny", "cloudy", "unstable", "thunderstorm" or "unknown" V_RAIN = 6, //!< S_RAIN. Amount of rain V_RAINRATE = 7, //!< S_RAIN. Rate of rain V_WIND = 8, //!< S_WIND. Wind speed V_GUST = 9, //!< S_WIND. Gust V_DIRECTION = 10, //!< S_WIND. Wind direction 0-360 (degrees) V_UV = 11, //!< S_UV. UV light level V_WEIGHT = 12, //!< S_WEIGHT. Weight(for scales etc) V_DISTANCE = 13, //!< S_DISTANCE. Distance V_IMPEDANCE = 14, //!< S_MULTIMETER, S_WEIGHT. Impedance value V_ARMED = 15, //!< S_DOOR, S_MOTION, S_SMOKE, S_SPRINKLER. Armed status of a security sensor. 1 = Armed, 0 = Bypassed V_TRIPPED = 16, //!< S_DOOR, S_MOTION, S_SMOKE, S_SPRINKLER, S_WATER_LEAK, S_SOUND, S_VIBRATION, S_MOISTURE. Tripped status of a security sensor. 1 = Tripped, 0 V_WATT = 17, //!< S_POWER, S_BINARY, S_DIMMER, S_RGB_LIGHT, S_RGBW_LIGHT. Watt value for power meters V_KWH = 18, //!< S_POWER. Accumulated number of KWH for a power meter V_SCENE_ON = 19, //!< S_SCENE_CONTROLLER. Turn on a scene V_SCENE_OFF = 20, //!< S_SCENE_CONTROLLER. Turn of a scene V_HVAC_FLOW_STATE = 21, //!< S_HEATER, S_HVAC. HVAC flow state ("Off", "HeatOn", "CoolOn", or "AutoChangeOver") V_HEATER = 21, //!< \deprecated Same as V_HVAC_FLOW_STATE V_HVAC_SPEED = 22, //!< S_HVAC, S_HEATER. HVAC/Heater fan speed ("Min", "Normal", "Max", "Auto") V_LIGHT_LEVEL = 23, //!< S_LIGHT_LEVEL. Uncalibrated light level. 0-100%. Use V_LEVEL for light level in lux V_VAR1 = 24, //!< VAR1 V_VAR2 = 25, //!< VAR2 V_VAR3 = 26, //!< VAR3 V_VAR4 = 27, //!< VAR4 V_VAR5 = 28, //!< VAR5 V_UP = 29, //!< S_COVER. Window covering. Up V_DOWN = 30, //!< S_COVER. Window covering. Down V_STOP = 31, //!< S_COVER. Window covering. Stop V_IR_SEND = 32, //!< S_IR. Send out an IR-command V_IR_RECEIVE = 33, //!< S_IR. This message contains a received IR-command V_FLOW = 34, //!< S_WATER. Flow of water (in meter) V_VOLUME = 35, //!< S_WATER. Water volume V_LOCK_STATUS = 36, //!< S_LOCK. Set or get lock status. 1=Locked, 0=Unlocked V_LEVEL = 37, //!< S_DUST, S_AIR_QUALITY, S_SOUND (dB), S_VIBRATION (hz), S_LIGHT_LEVEL (lux) V_VOLTAGE = 38, //!< S_MULTIMETER V_CURRENT = 39, //!< S_MULTIMETER V_RGB = 40, //!< S_RGB_LIGHT, S_COLOR_SENSOR. Sent as ASCII hex: RRGGBB (RR=red, GG=green, BB=blue component) V_RGBW = 41, //!< S_RGBW_LIGHT. Sent as ASCII hex: RRGGBBWW (WW=white component) V_ID = 42, //!< Used for sending in sensors hardware ids (i.e. OneWire DS1820b). V_UNIT_PREFIX = 43, //!< Allows sensors to send in a string representing the unit prefix to be displayed in GUI, not parsed by controller! E.g. cm, m, km, inch. V_HVAC_SETPOINT_COOL = 44, //!< S_HVAC. HVAC cool setpoint (Integer between 0-100) V_HVAC_SETPOINT_HEAT = 45, //!< S_HEATER, S_HVAC. HVAC/Heater setpoint (Integer between 0-100) V_HVAC_FLOW_MODE = 46, //!< S_HVAC. Flow mode for HVAC ("Auto", "ContinuousOn", "PeriodicOn") V_TEXT = 47, //!< S_INFO. Text message to display on LCD or controller device V_CUSTOM = 48, //!< Custom messages used for controller/inter node specific commands, preferably using S_CUSTOM device type. V_POSITION = 49, //!< GPS position and altitude. Payload: latitude;longitude;altitude(m). E.g. "55.722526;13.017972;18" V_IR_RECORD = 50, //!< Record IR codes S_IR for playback V_PH = 51, //!< S_WATER_QUALITY, water PH V_ORP = 52, //!< S_WATER_QUALITY, water ORP : redox potential in mV V_EC = 53, //!< S_WATER_QUALITY, water electric conductivity μS/cm (microSiemens/cm) V_VAR = 54, //!< S_POWER, Reactive power: volt-ampere reactive (var) V_VA = 55, //!< S_POWER, Apparent power: volt-ampere (VA) V_POWER_FACTOR = 56, //!< S_POWER, Ratio of real power to apparent power: floating point value in the range [-1,..,1] } mysensors_data_t; /// @brief Type of internal messages (for internal messages) typedef enum { I_BATTERY_LEVEL = 0, //!< Battery level I_TIME = 1, //!< Time (request/response) I_VERSION = 2, //!< Version I_ID_REQUEST = 3, //!< ID request I_ID_RESPONSE = 4, //!< ID response I_INCLUSION_MODE = 5, //!< Inclusion mode I_CONFIG = 6, //!< Config (request/response) I_FIND_PARENT_REQUEST = 7, //!< Find parent I_FIND_PARENT_RESPONSE = 8, //!< Find parent response I_LOG_MESSAGE = 9, //!< Log message I_CHILDREN = 10, //!< Children I_SKETCH_NAME = 11, //!< Sketch name I_SKETCH_VERSION = 12, //!< Sketch version I_REBOOT = 13, //!< Reboot request I_GATEWAY_READY = 14, //!< Gateway ready I_SIGNING_PRESENTATION = 15, //!< Provides signing related preferences (first byte is preference version) I_NONCE_REQUEST = 16, //!< Request for a nonce I_NONCE_RESPONSE = 17, //!< Payload is nonce data I_HEARTBEAT_REQUEST = 18, //!< Heartbeat request I_PRESENTATION = 19, //!< Presentation message I_DISCOVER_REQUEST = 20, //!< Discover request I_DISCOVER_RESPONSE = 21, //!< Discover response I_HEARTBEAT_RESPONSE = 22, //!< Heartbeat response I_LOCKED = 23, //!< Node is locked (reason in string-payload) I_PING = 24, //!< Ping sent to node, payload incremental hop counter I_PONG = 25, //!< In return to ping, sent back to sender, payload incremental hop counter I_REGISTRATION_REQUEST = 26, //!< Register request to GW I_REGISTRATION_RESPONSE = 27, //!< Register response from GW I_DEBUG = 28, //!< Debug message I_SIGNAL_REPORT_REQUEST = 29, //!< Device signal strength request I_SIGNAL_REPORT_REVERSE = 30, //!< Internal I_SIGNAL_REPORT_RESPONSE = 31, //!< Device signal strength response (RSSI) I_PRE_SLEEP_NOTIFICATION = 32, //!< Message sent before node is going to sleep I_POST_SLEEP_NOTIFICATION = 33 //!< Message sent after node woke up (if enabled) } mysensors_internal_t; /// @brief Type of data stream (for streamed message) typedef enum { ST_FIRMWARE_CONFIG_REQUEST = 0, //!< Request new FW, payload contains current FW details ST_FIRMWARE_CONFIG_RESPONSE = 1, //!< New FW details to initiate OTA FW update ST_FIRMWARE_REQUEST = 2, //!< Request FW block ST_FIRMWARE_RESPONSE = 3, //!< Response FW block ST_SOUND = 4, //!< Sound ST_IMAGE = 5, //!< Image ST_FIRMWARE_CONFIRM = 6, //!< Mark running firmware as valid (MyOTAFirmwareUpdateNVM + mcuboot) ST_FIRMWARE_RESPONSE_RLE = 7, //!< Response FW block with run length encoded data } mysensors_stream_t; /// @brief Type of payload typedef enum { P_STRING = 0, //!< Payload type is string P_BYTE = 1, //!< Payload type is byte P_INT16 = 2, //!< Payload type is INT16 P_UINT16 = 3, //!< Payload type is UINT16 P_LONG32 = 4, //!< Payload type is INT32 P_ULONG32 = 5, //!< Payload type is UINT32 P_CUSTOM = 6, //!< Payload type is binary P_FLOAT32 = 7 //!< Payload type is float32 } mysensors_payload_t; typedef union { struct { uint8_t last; //!< 8 bit - Id of last node this message passed uint8_t sender; //!< 8 bit - Id of sender node (origin) uint8_t destination; //!< 8 bit - Id of destination node /** * 2 bit - Protocol version
* 1 bit - Signed flag
* 5 bit - Length of payload */ uint8_t version_length; /** * 3 bit - Command type
* 1 bit - Request an echo - Indicator that receiver should echo the message back to the sender
* 1 bit - Is echo message - Indicator that this is the echoed message
* 3 bit - Payload data type */ uint8_t command_echo_payload; uint8_t type; //!< 8 bit - Type varies depending on command uint8_t sensor; //!< 8 bit - Id of sensor that this message concerns. /* * Each message can transfer a payload. We add one extra byte for string * terminator \0 to be "printable" this is not transferred OTA * This union is used to simplify the construction of the binary data types transferred. */ union { uint8_t bValue; //!< unsigned byte value (8-bit) uint16_t uiValue; //!< unsigned integer value (16-bit) int16_t iValue; //!< signed integer value (16-bit) uint32_t ulValue; //!< unsigned long value (32-bit) int32_t lValue; //!< signed long value (32-bit) struct { //!< Float messages float fValue; uint8_t fPrecision; //!< Number of decimals when serializing }; char data[MAX_PAYLOAD_SIZE + 1]; //!< Buffer for raw payload data }; }; uint8_t array[HEADER_SIZE + MAX_PAYLOAD_SIZE + 1]; //!< buffer for entire message } MyMessage; void delay(uint32_t i); void registerNode(void); void present_node(void); _Bool present(const uint8_t sensorId, const mysensors_sensor_t sensorType, char *desc); _Bool sendSketchInfo(const char *name, const char *version); _Bool send(MyMessage *msg,uint8_t data_type); _Bool sendHeartbeat(void); void receive(const MyMessage*); void transportProcessMessage(void); _Bool transportSend(MyMessage *message); void transportInitialise(void); void transportProcess(void); uint8_t transportReceive(void *data); _Bool isMessageReceived(void); void resetMessageReceived(void); uint32_t transportGetHeartbeat(void); #endif // MySensors_h