Added some more docs for MyMessage

This commit is contained in:
Patrick Fallberg
2015-12-11 00:40:03 +01:00
parent 5142cdc936
commit 313bcf05f8
+11 -11
View File
@@ -24,7 +24,7 @@
* @defgroup MyMessagegrp MyMessage
* @{
*
* @brief Here you can find all message types used my the MySensors protocol as well as macros for
* @brief Here you can find all message types used by the MySensors protocol as well as macros for
* parsing and manipulating messages.
*/
#ifndef MyMessage_h
@@ -36,18 +36,18 @@
#include <stdint.h>
#endif
#define PROTOCOL_VERSION 2
#define MAX_MESSAGE_LENGTH 32
#define HEADER_SIZE 7
#define MAX_PAYLOAD (MAX_MESSAGE_LENGTH - HEADER_SIZE)
#define PROTOCOL_VERSION 2 //!< The version of the protocol
#define MAX_MESSAGE_LENGTH 32 //!< The maximum size of a message (including header)
#define HEADER_SIZE 7 //!< The size of the header
#define MAX_PAYLOAD (MAX_MESSAGE_LENGTH - HEADER_SIZE) //!< The maximum size of a payload depends on #MAX_MESSAGE_LENGTH and #HEADER_SIZE
// Message types
/// @brief The command field (message-type) defines the overall properties of a message
typedef enum {
C_PRESENTATION = 0,
C_SET = 1,
C_REQ = 2,
C_INTERNAL = 3,
C_STREAM = 4 // For Firmware and other larger chunks of data that need to be divided into pieces.
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.
} mysensor_command;
// Type of sensor (used when presenting sensors)