Macros | Typedefs | Enumerations | Variables
message_flags.h File Reference

Contains various enums and structs used to facilitate communication between Toposens sensors and other devices. More...

#include <stdint.h>
Include dependency graph for message_flags.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ADC_FRAME_CH_1_OFFSET   2
 
#define ADC_FRAME_CH_2_OFFSET   4
 
#define ADC_FRAME_CH_3_OFFSET   6
 
#define ADC_FRAME_COUNT_OFFSET   1
 
#define ADC_FRAME_LEN   8
 
#define APP_PACKET_LEN   142
 
#define CAN_MAX_FRAME_LEN   8
 
#define COMPLETE_ACK_UPDATE_LEN   2
 
#define CONTROL_BYTE_IDX   0
 
#define DIST_1D_OFFSET   1
 
#define ENCRYPTED_SECRET_KEY_LEN   48
 
#define EOS_ACK_LEN   2
 
#define EOS_FRAME_LEN   1
 
#define FW_ACTION_ACK_LEN   2
 
#define FW_ACTION_NACK_LEN   2
 
#define GENERAL_ACK_LEN   3
 
#define GENERAL_NACK_LEN   4
 
#define GET_NACK_LEN   4
 
#define INDEXED_GET_MESSAGE_LEN   4
 
#define INIT_APP_UPDATE_LEN   46
 
#define INTENSITY_1D_OFFSET   3
 
#define INTENSITY_3D_OFFSET   7
 
#define LOG_STRING_OVERHEAD_BYTES   3
 
#define LOGGING_CATEGORY_BYTE   1
 
#define LOGGING_ISSUE_BYTE_1   2
 
#define LOGGING_ISSUE_BYTE_2   3
 
#define LOGGING_ISSUE_BYTE_3   4
 
#define LOGGING_SEVERITY_BYTE   0
 
#define MAX_APP_SIZE   262144
 
#define MAX_LOG_STRING_LEN   (255 - LOG_STRING_OVERHEAD_BYTES)
 
#define MAX_UART_MESSAGE_LEN   255
 
#define NOISE_LEVEL_FRAME_LEN   3
 
#define PARAM_BYTE_1_IDX   2
 
#define PARAM_BYTE_2_IDX   3
 
#define PARAM_BYTE_3_IDX   4
 
#define PARAM_BYTE_4_IDX   5
 
#define PARAM_BYTE_5_IDX   6
 
#define PARAM_BYTE_6_IDX   7
 
#define POINT_FRAME_1D_LEN   4
 
#define POINT_FRAME_3D_LEN   8
 
#define READY_NOTIFICATION_LEN   3
 
#define SET_ACK_LEN   4
 
#define STANDARD_GET_MESSAGE_LEN   3
 
#define START_ADC_DUMP_SESSION_ACK_LEN   7
 
#define START_ADC_DUMP_SESSION_LEN   6
 
#define START_POINT_SESSION_ACK_LEN   4
 
#define START_POINT_SESSION_LEN   3
 
#define SUBCONTROL_BYTE_IDX   1
 
#define TRIGGER_ACK_LEN   3
 
#define TRIGGER_LEN   2
 
#define UART_APP_PACKET_DATA_LEN   128
 
#define UART_MAX_FRAME_LEN   255
 
#define USB_APP_PACKET_DATA_LEN   47
 
#define VERSION_REPLY_LEN   5
 
#define X_OFFSET   1
 
#define Y_OFFSET   3
 
#define Z_OFFSET   5
 

Typedefs

typedef enum ACKStausByte_t ACKStausByte_t
 
typedef enum ActionByte_t ActionByte_t
 
typedef enum ADCFrameTypeByte_t ADCFrameTypeByte_t
 
typedef enum ADCParamByte_t ADCParamByte_t
 
typedef enum ControlByte_t ControlByte_t
 
typedef enum FirmwareUploadActionByte_t FirmwareUploadActionByte_t
 
typedef enum ParamGroupByte_t ParamGroupByte_t
 
typedef enum PointTypeByte_t PointTypeByte_t
 
typedef enum SignalProcessingParamByte_t SignalProcessingParamByte_t
 
typedef enum SystemParamByte_t SystemParamByte_t
 
typedef enum TransducerParamByte_t TransducerParamByte_t
 
typedef enum VersionByte_t VersionByte_t
 

Enumerations

enum  ACKStausByte_t { ACK_STATUS_BYTE_SUCCESS = 0x00, ACK_STATUS_BYTE_OUT_OF_RANGE = 0x01, ACK_STATUS_BYTE_OPERATION_INVALID = 0x02, ACK_STATUS_BYTE_FALLBACK = 0x03 }
 
enum  ActionByte_t {
  ACTION_BYTE_REBOOT = 0x00, ACTION_BYTE_MEASUREMENT = 0x01, ACTION_BYTE_FACTORY_DEFAULTS = 0x02, ACTION_BYTE_STORE_SETTINGS = 0x03,
  ACTION_BYTE_LOAD_SETTINGS = 0x04, ACTION_BYTE_ADC_DUMP = 0x05
}
 
enum  ADCFrameTypeByte_t { ADC_FRAME_TYPE_DATA = 0x21 }
 
enum  ADCParamByte_t { ADC_PARAM_BYTE_USE_FIXED_FRAME_RATE = 0x00, ADC_PARAM_BYTE_FRAME_RATE = 0x01 }
 
enum  ControlByte_t {
  CONTROL_BYTE_EOS = 0x00, CONTROL_BYTE_ACK = 0x01, CONTROL_BYTE_NACK = 0x02, CONTROL_BYTE_READY = 0x03,
  CONTROL_BYTE_BEGIN_POINT_OUTPUT_SESSION = 0x10, CONTROL_BYTE_BEGIN_ADC_DUMP_SESSION = 0x20, CONTROL_BYTE_TRIGGER_ACTION = 0x30, CONTROL_BYTE_TRIGGER_ACTION_ACK = 0x31,
  CONTROL_BYTE_FW_UPDATE_ACTION = 0x40, CONTROL_BYTE_FW_UPDATE_ACTION_NACK = 0x41, CONTROL_BYTE_FW_UPDATE_ACTION_ACK = 0x42, CONTROL_BYTE_SET = 0x60,
  CONTROL_BYTE_SET_ACK = 0x61, CONTROL_BYTE_GET = 0x90, CONTROL_BYTE_GET_REPLY = 0x91, CONTROL_BYTE_GET_NACK = 0x92,
  CONTROL_BYTE_VERSION = 0xB0, CONTROL_BYTE_GET_VERSION_REPLY = 0xB1, CONTROL_BYTE_LOG_DEBUG = 0XA0, CONTROL_BYTE_LOG_INFO = 0XA1,
  CONTROL_BYTE_LOG_WARN = 0XA2, CONTROL_BYTE_LOG_ERROR = 0XA3
}
 
enum  FirmwareUploadActionByte_t { FW_UPLOAD_ACTION_BYTE_INIT = 0x00, FW_UPLOAD_ACTION_BYTE_BLOB_IN = 0x01, FW_UPLOAD_ACTION_BYTE_COMPLETE = 0x02 }
 
enum  ParamGroupByte_t { PARAM_GROUP_BYTE_ADC = 0x00, PARAM_GROUP_BYTE_TRANSDUCER = 0x01, PARAM_GROUP_BYTE_SIGNAL_PROCESSING = 0x02, PARAM_GROUP_BYTE_SYSTEM = 0x03 }
 
enum  PointTypeByte_t { POINT_TYPE_BYTE_3D = 0x11, POINT_TYPE_BYTE_NEAR_FIELD = 0x12, POINT_TYPE_BYTE_NOISE_LEVEL = 0x13, POINT_TYPE_BYTE_1D = 0x14 }
 
enum  SignalProcessingParamByte_t {
  SIGPRO_PARAM_BYTE_TEMPERATURE = 0x01, SIGPRO_PARAM_BYTE_RELATIVE_HUMIDITY = 0x02, SIGPRO_PARAM_BYTE_NOISE_LEVEL_THRESHOLD_FACTOR = 0x03, SIGPRO_PARAM_BYTE_NOISE_RATIO_THRESHOLD = 0x04,
  SIGPRO_PARAM_BYTE_ENABLE_NEAR_FIELD_DETECTION = 0x05, SIGPRO_PARAM_BYTE_ENABLE_DIRECT_MULTIPATH_FILTER = 0x06, SIGPRO_PARAM_BYTE_ENABLE_AUTO_GAIN = 0x07
}
 
enum  SystemParamByte_t {
  SYS_PARAM_BYTE_NODE_ID = 0x00, SYS_PARAM_BYTE_MCU_TEMPERATURE = 0x01, SYS_PARAM_BYTE_LOG_LEVEL = 0x02, SYS_PARAM_BYTE_RESET_REASON = 0x03,
  SYS_PARAM_BYTE_SENSOR_STATE = 0x04, SYS_PARAM_BYTE_SENSOR_MODE = 0x05, SYS_PARAM_BYTE_UNIQUE_ID = 0x06, SYS_PARAM_BYTE_CALIBRATION_STATE = 0x07
}
 
enum  TransducerParamByte_t { TRANSDUCER_PARAM_BYTE_VOLUME = 0x00, TRANSDUCER_PARAM_BYTE_NUMBER_PULSES = 0x01 }
 
enum  VersionByte_t {
  VERSION_BYTE_BOOTLOADER = 0x00, VERSION_BYTE_APP = 0x01, VERSION_BYTE_HW = 0x02, VERSION_BYTE_SIG_PRO_LIB = 0x03,
  VERSION_BYTE_COMMS_LIB = 0x04
}
 

Variables

static const char * kACKStatusStrings []
 
static const char * kActionCommands []
 
static const char * kFirmwareUploadActionStrings []
 
static const char * kVersionStrings []
 

Detailed Description

Contains various enums and structs used to facilitate communication between Toposens sensors and other devices.


Definition in file message_flags.h.

Macro Definition Documentation

◆ ADC_FRAME_CH_1_OFFSET

#define ADC_FRAME_CH_1_OFFSET   2

Definition at line 50 of file message_flags.h.

◆ ADC_FRAME_CH_2_OFFSET

#define ADC_FRAME_CH_2_OFFSET   4

Definition at line 51 of file message_flags.h.

◆ ADC_FRAME_CH_3_OFFSET

#define ADC_FRAME_CH_3_OFFSET   6

Definition at line 52 of file message_flags.h.

◆ ADC_FRAME_COUNT_OFFSET

#define ADC_FRAME_COUNT_OFFSET   1

Definition at line 49 of file message_flags.h.

◆ ADC_FRAME_LEN

#define ADC_FRAME_LEN   8

Definition at line 53 of file message_flags.h.

◆ APP_PACKET_LEN

#define APP_PACKET_LEN   142

Definition at line 59 of file message_flags.h.

◆ CAN_MAX_FRAME_LEN

#define CAN_MAX_FRAME_LEN   8

Definition at line 15 of file message_flags.h.

◆ COMPLETE_ACK_UPDATE_LEN

#define COMPLETE_ACK_UPDATE_LEN   2

Definition at line 60 of file message_flags.h.

◆ CONTROL_BYTE_IDX

#define CONTROL_BYTE_IDX   0

Definition at line 17 of file message_flags.h.

◆ DIST_1D_OFFSET

#define DIST_1D_OFFSET   1

Definition at line 46 of file message_flags.h.

◆ ENCRYPTED_SECRET_KEY_LEN

#define ENCRYPTED_SECRET_KEY_LEN   48

Definition at line 71 of file message_flags.h.

◆ EOS_ACK_LEN

#define EOS_ACK_LEN   2

Definition at line 39 of file message_flags.h.

◆ EOS_FRAME_LEN

#define EOS_FRAME_LEN   1

Definition at line 54 of file message_flags.h.

◆ FW_ACTION_ACK_LEN

#define FW_ACTION_ACK_LEN   2

Definition at line 68 of file message_flags.h.

◆ FW_ACTION_NACK_LEN

#define FW_ACTION_NACK_LEN   2

Definition at line 67 of file message_flags.h.

◆ GENERAL_ACK_LEN

#define GENERAL_ACK_LEN   3

Definition at line 28 of file message_flags.h.

◆ GENERAL_NACK_LEN

#define GENERAL_NACK_LEN   4

Definition at line 27 of file message_flags.h.

◆ GET_NACK_LEN

#define GET_NACK_LEN   4

Definition at line 29 of file message_flags.h.

◆ INDEXED_GET_MESSAGE_LEN

#define INDEXED_GET_MESSAGE_LEN   4

Definition at line 56 of file message_flags.h.

◆ INIT_APP_UPDATE_LEN

#define INIT_APP_UPDATE_LEN   46

Definition at line 58 of file message_flags.h.

◆ INTENSITY_1D_OFFSET

#define INTENSITY_1D_OFFSET   3

Definition at line 45 of file message_flags.h.

◆ INTENSITY_3D_OFFSET

#define INTENSITY_3D_OFFSET   7

Definition at line 44 of file message_flags.h.

◆ LOG_STRING_OVERHEAD_BYTES

#define LOG_STRING_OVERHEAD_BYTES   3

Definition at line 64 of file message_flags.h.

◆ LOGGING_CATEGORY_BYTE

#define LOGGING_CATEGORY_BYTE   1

Definition at line 74 of file message_flags.h.

◆ LOGGING_ISSUE_BYTE_1

#define LOGGING_ISSUE_BYTE_1   2

Definition at line 75 of file message_flags.h.

◆ LOGGING_ISSUE_BYTE_2

#define LOGGING_ISSUE_BYTE_2   3

Definition at line 76 of file message_flags.h.

◆ LOGGING_ISSUE_BYTE_3

#define LOGGING_ISSUE_BYTE_3   4

Definition at line 77 of file message_flags.h.

◆ LOGGING_SEVERITY_BYTE

#define LOGGING_SEVERITY_BYTE   0

Definition at line 73 of file message_flags.h.

◆ MAX_APP_SIZE

#define MAX_APP_SIZE   262144

Definition at line 69 of file message_flags.h.

◆ MAX_LOG_STRING_LEN

#define MAX_LOG_STRING_LEN   (255 - LOG_STRING_OVERHEAD_BYTES)

Definition at line 66 of file message_flags.h.

◆ MAX_UART_MESSAGE_LEN

#define MAX_UART_MESSAGE_LEN   255

Definition at line 65 of file message_flags.h.

◆ NOISE_LEVEL_FRAME_LEN

#define NOISE_LEVEL_FRAME_LEN   3

Definition at line 40 of file message_flags.h.

◆ PARAM_BYTE_1_IDX

#define PARAM_BYTE_1_IDX   2

Definition at line 19 of file message_flags.h.

◆ PARAM_BYTE_2_IDX

#define PARAM_BYTE_2_IDX   3

Definition at line 20 of file message_flags.h.

◆ PARAM_BYTE_3_IDX

#define PARAM_BYTE_3_IDX   4

Definition at line 21 of file message_flags.h.

◆ PARAM_BYTE_4_IDX

#define PARAM_BYTE_4_IDX   5

Definition at line 22 of file message_flags.h.

◆ PARAM_BYTE_5_IDX

#define PARAM_BYTE_5_IDX   6

Definition at line 23 of file message_flags.h.

◆ PARAM_BYTE_6_IDX

#define PARAM_BYTE_6_IDX   7

Definition at line 24 of file message_flags.h.

◆ POINT_FRAME_1D_LEN

#define POINT_FRAME_1D_LEN   4

Definition at line 48 of file message_flags.h.

◆ POINT_FRAME_3D_LEN

#define POINT_FRAME_3D_LEN   8

Definition at line 47 of file message_flags.h.

◆ READY_NOTIFICATION_LEN

#define READY_NOTIFICATION_LEN   3

Definition at line 32 of file message_flags.h.

◆ SET_ACK_LEN

#define SET_ACK_LEN   4

Definition at line 30 of file message_flags.h.

◆ STANDARD_GET_MESSAGE_LEN

#define STANDARD_GET_MESSAGE_LEN   3

Definition at line 55 of file message_flags.h.

◆ START_ADC_DUMP_SESSION_ACK_LEN

#define START_ADC_DUMP_SESSION_ACK_LEN   7

Definition at line 38 of file message_flags.h.

◆ START_ADC_DUMP_SESSION_LEN

#define START_ADC_DUMP_SESSION_LEN   6

Definition at line 36 of file message_flags.h.

◆ START_POINT_SESSION_ACK_LEN

#define START_POINT_SESSION_ACK_LEN   4

Definition at line 37 of file message_flags.h.

◆ START_POINT_SESSION_LEN

#define START_POINT_SESSION_LEN   3

Definition at line 35 of file message_flags.h.

◆ SUBCONTROL_BYTE_IDX

#define SUBCONTROL_BYTE_IDX   1

Definition at line 18 of file message_flags.h.

◆ TRIGGER_ACK_LEN

#define TRIGGER_ACK_LEN   3

Definition at line 31 of file message_flags.h.

◆ TRIGGER_LEN

#define TRIGGER_LEN   2

Definition at line 33 of file message_flags.h.

◆ UART_APP_PACKET_DATA_LEN

#define UART_APP_PACKET_DATA_LEN   128

Definition at line 62 of file message_flags.h.

◆ UART_MAX_FRAME_LEN

#define UART_MAX_FRAME_LEN   255

Definition at line 16 of file message_flags.h.

◆ USB_APP_PACKET_DATA_LEN

#define USB_APP_PACKET_DATA_LEN   47

Definition at line 63 of file message_flags.h.

◆ VERSION_REPLY_LEN

#define VERSION_REPLY_LEN   5

Definition at line 26 of file message_flags.h.

◆ X_OFFSET

#define X_OFFSET   1

Definition at line 41 of file message_flags.h.

◆ Y_OFFSET

#define Y_OFFSET   3

Definition at line 42 of file message_flags.h.

◆ Z_OFFSET

#define Z_OFFSET   5

Definition at line 43 of file message_flags.h.

Typedef Documentation

◆ ACKStausByte_t

◆ ActionByte_t

typedef enum ActionByte_t ActionByte_t

◆ ADCFrameTypeByte_t

◆ ADCParamByte_t

◆ ControlByte_t

◆ FirmwareUploadActionByte_t

◆ ParamGroupByte_t

◆ PointTypeByte_t

◆ SignalProcessingParamByte_t

◆ SystemParamByte_t

◆ TransducerParamByte_t

◆ VersionByte_t

Enumeration Type Documentation

◆ ACKStausByte_t

Enumerator
ACK_STATUS_BYTE_SUCCESS 
ACK_STATUS_BYTE_OUT_OF_RANGE 
ACK_STATUS_BYTE_OPERATION_INVALID 
ACK_STATUS_BYTE_FALLBACK 

Definition at line 179 of file message_flags.h.

◆ ActionByte_t

Enumerator
ACTION_BYTE_REBOOT 
ACTION_BYTE_MEASUREMENT 
ACTION_BYTE_FACTORY_DEFAULTS 
ACTION_BYTE_STORE_SETTINGS 
ACTION_BYTE_LOAD_SETTINGS 
ACTION_BYTE_ADC_DUMP 

Definition at line 129 of file message_flags.h.

◆ ADCFrameTypeByte_t

Enumerator
ADC_FRAME_TYPE_DATA 

Definition at line 164 of file message_flags.h.

◆ ADCParamByte_t

Enumerator
ADC_PARAM_BYTE_USE_FIXED_FRAME_RATE 
ADC_PARAM_BYTE_FRAME_RATE 

Definition at line 192 of file message_flags.h.

◆ ControlByte_t

Enumerator
CONTROL_BYTE_EOS 
CONTROL_BYTE_ACK 
CONTROL_BYTE_NACK 
CONTROL_BYTE_READY 
CONTROL_BYTE_BEGIN_POINT_OUTPUT_SESSION 
CONTROL_BYTE_BEGIN_ADC_DUMP_SESSION 
CONTROL_BYTE_TRIGGER_ACTION 
CONTROL_BYTE_TRIGGER_ACTION_ACK 
CONTROL_BYTE_FW_UPDATE_ACTION 
CONTROL_BYTE_FW_UPDATE_ACTION_NACK 
CONTROL_BYTE_FW_UPDATE_ACTION_ACK 
CONTROL_BYTE_SET 
CONTROL_BYTE_SET_ACK 
CONTROL_BYTE_GET 
CONTROL_BYTE_GET_REPLY 
CONTROL_BYTE_GET_NACK 
CONTROL_BYTE_VERSION 
CONTROL_BYTE_GET_VERSION_REPLY 
CONTROL_BYTE_LOG_DEBUG 
CONTROL_BYTE_LOG_INFO 
CONTROL_BYTE_LOG_WARN 
CONTROL_BYTE_LOG_ERROR 

Definition at line 79 of file message_flags.h.

◆ FirmwareUploadActionByte_t

Enumerator
FW_UPLOAD_ACTION_BYTE_INIT 
FW_UPLOAD_ACTION_BYTE_BLOB_IN 
FW_UPLOAD_ACTION_BYTE_COMPLETE 

Definition at line 169 of file message_flags.h.

◆ ParamGroupByte_t

Enumerator
PARAM_GROUP_BYTE_ADC 
PARAM_GROUP_BYTE_TRANSDUCER 
PARAM_GROUP_BYTE_SIGNAL_PROCESSING 
PARAM_GROUP_BYTE_SYSTEM 

Definition at line 121 of file message_flags.h.

◆ PointTypeByte_t

Enumerator
POINT_TYPE_BYTE_3D 
POINT_TYPE_BYTE_NEAR_FIELD 
POINT_TYPE_BYTE_NOISE_LEVEL 
POINT_TYPE_BYTE_1D 

Definition at line 156 of file message_flags.h.

◆ SignalProcessingParamByte_t

Enumerator
SIGPRO_PARAM_BYTE_TEMPERATURE 
SIGPRO_PARAM_BYTE_RELATIVE_HUMIDITY 
SIGPRO_PARAM_BYTE_NOISE_LEVEL_THRESHOLD_FACTOR 
SIGPRO_PARAM_BYTE_NOISE_RATIO_THRESHOLD 
SIGPRO_PARAM_BYTE_ENABLE_NEAR_FIELD_DETECTION 
SIGPRO_PARAM_BYTE_ENABLE_DIRECT_MULTIPATH_FILTER 
SIGPRO_PARAM_BYTE_ENABLE_AUTO_GAIN 

Definition at line 204 of file message_flags.h.

◆ SystemParamByte_t

Enumerator
SYS_PARAM_BYTE_NODE_ID 
SYS_PARAM_BYTE_MCU_TEMPERATURE 
SYS_PARAM_BYTE_LOG_LEVEL 
SYS_PARAM_BYTE_RESET_REASON 
SYS_PARAM_BYTE_SENSOR_STATE 
SYS_PARAM_BYTE_SENSOR_MODE 
SYS_PARAM_BYTE_UNIQUE_ID 
SYS_PARAM_BYTE_CALIBRATION_STATE 

Definition at line 215 of file message_flags.h.

◆ TransducerParamByte_t

Enumerator
TRANSDUCER_PARAM_BYTE_VOLUME 
TRANSDUCER_PARAM_BYTE_NUMBER_PULSES 

Definition at line 198 of file message_flags.h.

◆ VersionByte_t

Enumerator
VERSION_BYTE_BOOTLOADER 
VERSION_BYTE_APP 
VERSION_BYTE_HW 
VERSION_BYTE_SIG_PRO_LIB 
VERSION_BYTE_COMMS_LIB 

Definition at line 143 of file message_flags.h.

Variable Documentation

◆ kACKStatusStrings

const char* kACKStatusStrings[]
static
Initial value:
= {"successfully acknowledged",
"negatively acknowledged (Parameter out of range)",
"negatively acknowledged (Invalid operation)",
"negatively acknowledged (Falling back to default)"}

Definition at line 187 of file message_flags.h.

◆ kActionCommands

const char* kActionCommands[]
static
Initial value:
= {"Perform Reboot", "Perform Measurement",
"Perform Factory Reset", "Store Settings",
"Load Settings", "Perform ADC Dump"}

Definition at line 139 of file message_flags.h.

◆ kFirmwareUploadActionStrings

const char* kFirmwareUploadActionStrings[]
static
Initial value:
= {"Init FW Upload", "App Packet",
"Complete Update"}

Definition at line 176 of file message_flags.h.

◆ kVersionStrings

const char* kVersionStrings[]
static
Initial value:
= {"Bootloader Version", "Application Version",
"Hardware Version", "Signal Processing Library Version",
"Communication Library Version"}

Definition at line 152 of file message_flags.h.



toposens_echo_driver
Author(s): Tobias Roth , Dennis Maier , Baris Yazici
autogenerated on Mon Feb 28 2022 23:57:42