EnigmaIoT sensor node management structures. More...

#include "WProgram.h"
#include "EnigmaIoTconfig.h"
#include "Filter.h"

Classes
struct	node_instance
	Struct that define node fields. Used for long term storage needs. More...

class	Node
	Class definition for a single sensor Node. More...

class	NodeList

Typedefs
typedef enum node_status	status_t
	Node state. More...

typedef enum control_message_type	control_message_type_t

typedef enum ota_status	ota_status_t

typedef struct node_instance	node_t

Enumerations
enum	node_status { UNREGISTERED, INIT, WAIT_FOR_SERVER_HELLO, WAIT_FOR_DOWNLINK, REGISTERED, SLEEP }
	State definition for nodes. More...

enum	nodeNameStatus_t { NAME_OK = 0, ALREADY_USED = -1, EMPTY_NAME = -2, TOO_LONG = -3 }

enum	restartReason_t { RESTART_AFTER_OTA = 1, OTA_ERROR_RESTART = 2, RESTART_REQUESTED = 3, CONFIG_RESET = 4, USER_RESET = 5, IRRELEVANT = 10, UNKNOWN_REASON = 0 }

enum	control_message_type { VERSION = 0x01, VERSION_ANS = 0x81, SLEEP_GET = 0x02, SLEEP_SET = 0x03, SLEEP_ANS = 0x82, IDENTIFY = 0x04, RESET = 0x05, RESET_ANS = 0x85, RSSI_GET = 0x06, RSSI_ANS = 0x86, NAME_GET = 0x07, NAME_ANS = 0x08, NAME_SET = 0x87, RESTART_NODE = 0x09, RESTART_CONFIRM = 0x89, BRCAST_KEY = 0x10, OTA = 0xEF, OTA_ANS = 0xFF, USERDATA_GET = 0x00, USERDATA_SET = 0x20, INVALID = 0xF0 }

enum	ota_status { OTA_STARTED = 0, OTA_START_ERROR = 1, OTA_CHECK_OK = 2, OTA_CHECK_FAIL = 3, OTA_OUT_OF_SEQUENCE =4, OTA_TIMEOUT = 5, OTA_FINISHED = 6 }

Detailed Description

EnigmaIoT sensor node management structures.

Version: 0.9.8

Date: 15/07/2021

Author: German Martin

Definition in file NodeList.h.

Typedef Documentation

◆ control_message_type_t

typedef enum control_message_type control_message_type_t

◆ node_t

typedef struct node_instance node_t

Definition at line 1 of file NodeList.h.

◆ ota_status_t

typedef enum ota_status ota_status_t

◆ status_t

typedef enum node_status status_t

Node state.

Definition at line 1 of file NodeList.h.

Enumeration Type Documentation

◆ control_message_type

enum control_message_type

Enumerator
VERSION
VERSION_ANS
SLEEP_GET
SLEEP_SET
SLEEP_ANS
IDENTIFY
RESET
RESET_ANS
RSSI_GET
RSSI_ANS
NAME_GET
NAME_ANS
NAME_SET
RESTART_NODE
RESTART_CONFIRM
BRCAST_KEY
OTA
OTA_ANS
USERDATA_GET
USERDATA_SET
INVALID

Definition at line 51 of file NodeList.h.

◆ node_status

enum node_status

State definition for nodes.

Enumerator
UNREGISTERED	Node is not registered. This is te initial state of every node
INIT	Node is starting registration by ClientHello message
WAIT_FOR_SERVER_HELLO	Node sent ClientHello message, now it is waiting for ServerHello
WAIT_FOR_DOWNLINK	Node sent a data message, now it is waiting for downlink data
REGISTERED	Node is registered and its key is valid
SLEEP	Node is in sleep mode

Definition at line 23 of file NodeList.h.

◆ nodeNameStatus_t

enum nodeNameStatus_t

Enumerator
NAME_OK
ALREADY_USED
EMPTY_NAME
TOO_LONG

Definition at line 32 of file NodeList.h.

◆ ota_status

enum ota_status

Enumerator
OTA_STARTED
OTA_START_ERROR
OTA_CHECK_OK
OTA_CHECK_FAIL
OTA_OUT_OF_SEQUENCE
OTA_TIMEOUT
OTA_FINISHED

Definition at line 76 of file NodeList.h.

◆ restartReason_t

enum restartReason_t

Enumerator
RESTART_AFTER_OTA
OTA_ERROR_RESTART
RESTART_REQUESTED
CONFIG_RESET
USER_RESET
IRRELEVANT
UNKNOWN_REASON

Definition at line 41 of file NodeList.h.

Classes

Typedefs

Enumerations