Radio Telegram Structures

Collaboration diagram for Radio Telegram Structures:

Data Structures
union	sys_ex_data
	Sys_ex datafield definition. More...
union	smart_answer
	Smart ack Learn Asnwer telegram datafield definition. More...
struct	RADIO_BUFFER_TYPE
	Intern API structure for the processing of information in the radio buffers. More...
union	TEL_RADIO_TYPE
	Telegram structure used for Radio transmission. More...
union	TEL_PARAM_TYPE
	Telegram parameter structure. More...
union	TEL_RADIO_TYPE2
	Telegram structure used for radio communication using ERP2 protocol. More...
union	TEL_PARAM_TYPE2
	Telegram parameter structure for radio communication using ERP2 protocol. More...
union	EXT_TEL_PARAM_TYPE
	Extended Telegram parameter structure. More...

Macros
#define	GET_CHOICE(t)   ((t).raw.bytes[0])
	Macros for choice processing.
#define	GET_STATUS(t)   (t.raw.bytes[t.raw.u8Length-2])
	Macro for status processing - be sure that the u8Length of the telegram is set correctly.
#define	GET_ID(t)   *((uint32*)&((t).raw.bytes[(t).raw.u8Length-6]))
	Macro for id processing - be sure tht the u8Length of the telegram is set correctly.
#define	BROADCAST_ID   0xFFFFFFFF
	Destination broadcast ID, you can get the destination ID through TEL_PARAM_TYPE.
#define	RADIO2_HDR_SRCID24_BCAST   0x00
	EPR2 Defines.
#define	RADIO2_HDR_SRCID32_BCAST   0x20
	Originator ID 32 bit, no Destination ID.
#define	RADIO2_HDR_SRCID32_DEST32   0x40
	Originator ID 32 bit, Destination ID 32 bit.
#define	RADIO2_HDR_SRCID48_BCAST   0x60
	Originator ID 48 bit, no Destination ID.
#define	RADIO2_HDR_ID_MASK   0xE0
	RORG Mask. Bits 3..0.
#define	RADIO2_HDR_EXT_HDR   0x10
	Extrended header available.
#define	RADIO2_HDR_RORG_RPS   0x00
	RPS telegram.
#define	RADIO2_HDR_RORG_1BS   0x01
	1BS telegram
#define	RADIO2_HDR_RORG_4BS   0x02
	4BS telegram
#define	RADIO2_HDR_RORG_SIGNAL   0x03
	Smart Ack signal telegram.
#define	RADIO2_HDR_RORG_VLD   0x04
	Variable Length Data.
#define	RADIO2_HDR_RORG_UTE   0x05
	Universal Teach In EEP based.
#define	RADIO2_HDR_RORG_MSC   0x06
	Manufacturer Specific Communication.
#define	RADIO2_HDR_RORG_SEC   0x07
	Secure telegram without choice encapsulation.
#define	RADIO2_HDR_RORG_SECR   0x08
	Secure telegram with choice encapsulation.
#define	RADIO2_HDR_RORG_SEC_TI   0x09
	Secure teach-in telegram.
#define	RADIO2_HDR_RORG_GP_SEL   0x0A
	Generic profiles selective data.
#define	RADIO2_HDR_EXT_TEL   0x0F
	Extended telegram type available.
#define	RADIO2_HDR_RORG_MASK   0x0F
	RORG Mask. Bits 3..0.
#define	LEN_DEBUG_SUBTEL_INFO   6
	Length of one entry in debug buffer.

Enumerations
enum	CHOICE_TYPE {   RADIO_CHOICE_NONE = 0x00, RADIO_CHOICE_RPS = 0xF6, RADIO_CHOICE_1BS = 0xD5, RADIO_CHOICE_4BS = 0xA5, RADIO_CHOICE_HRC = 0xA3, RADIO_CHOICE_SYS = 0xA4, RADIO_CHOICE_SYS_EX = 0xC5, RADIO_CHOICE_SM_LRN_REQ = 0xC6, RADIO_CHOICE_SM_LRN_ANS = 0xC7, RADIO_CHOICE_RECLAIM = 0xA7, RADIO_CHOICE_ACK = 0xA8, RADIO_CHOICE_SIGNAL = 0xD0, RADIO_CHOICE_ADT = 0xA6, RADIO_CHOICE_VLD = 0xD2, RADIO_CHOICE_UTE = 0xD4, RADIO_CHOICE_MSC = 0xD1, RADIO_CHOICE_CDM = 0x40, RADIO_CHOICE_SEC = 0x30, RADIO_CHOICE_SEC_ENCAPS = 0x31, RADIO_CHOICE_NON_SEC = 0x32,   RADIO_CHOICE_SEC_CDM = 0x33, RADIO_CHOICE_SEC_MAINTENANCE = 0x34, RADIO_CHOICE_SEC_TI = 0x35, RADIO_CHOICE_GP_TEACH_IN = 0xB0, RADIO_CHOICE_GP_COMPLETE = 0xB2 }
	Telegram choice codes applies to radio telegram only. More...
enum	RADIO_TEL_LENGTH { RADIO_DEC_LENGTH_RPS = 8, RADIO_DEC_LENGTH_1BS = 8, RADIO_DEC_LENGTH_4BS = 11, RADIO_DEC_LENGTH_HRC = 8, RADIO_DEC_LENGTH_SYS = 11, RADIO_DEC_LENGTH_SYS_EX = 16, RADIO_DEC_LENGTH_SM_LRN_REQ = 17, RADIO_DEC_LENGTH_SM_LRN_ANS = 15, RADIO_DEC_LENGTH_SM_REC = 8, RADIO_DEC_LENGTH_SIGNAL = 8, RADIO_DEC_LENGTH_U2S = 6, RADIO_DEC_LENGTH_T2S = 6 }
	Length of the radio telegrams. More...
enum	STATUS_MASK { STATUS_CRC = 0x80, STATUS_GENERATION = 0x20, STATUS_ASSIGNED = 0x10, STATUS_REPEATER = 0x0F }
	Status byte masks. More...
enum	RADIO_INIT_PARAM { CFG_ANALOG0_RX = 0x00, CFG_ALL = 0x01, CFG_ANALOG0 = 0x02 }
	Radio init parameters. More...

---

Detailed Description

Structures that are used in RADIO module

---

Macro Definition Documentation

#define RADIO2_HDR_SRCID24_BCAST   0x00

EPR2 Defines.

Originator ID 24 bit, no Destination ID

---

Enumeration Type Documentation

enum CHOICE_TYPE

Telegram choice codes applies to radio telegram only.

Enumerator:

RADIO_CHOICE_NONE	No radio choice telegram.
RADIO_CHOICE_RPS	RPS telegram.
RADIO_CHOICE_1BS	1BS telegram
RADIO_CHOICE_4BS	4BS telegram
RADIO_CHOICE_HRC	HRC telegram.
RADIO_CHOICE_SYS	SYS telegram.
RADIO_CHOICE_SYS_EX	SYS_EX telegram.
RADIO_CHOICE_SM_LRN_REQ	Smart Ack Learn Reuqest telegram.
RADIO_CHOICE_SM_LRN_ANS	Smart Ack Learn Answer telegram.
RADIO_CHOICE_RECLAIM	Smart Ack Reclaim telegram.
RADIO_CHOICE_ACK	ACK telegram.
RADIO_CHOICE_SIGNAL	Smart Request telegram.
RADIO_CHOICE_ADT	Encapsulated addressable telegram.
RADIO_CHOICE_VLD	Variable Length Data.
RADIO_CHOICE_UTE	Universal Teach In EEP based.
RADIO_CHOICE_MSC	Manufacturer Specific Communication.
RADIO_CHOICE_CDM	Chained data message.
RADIO_CHOICE_SEC	Secure telegram.
RADIO_CHOICE_SEC_ENCAPS	Secure telegram with choice encapsulation.
RADIO_CHOICE_NON_SEC	Non-secure telegram.
RADIO_CHOICE_SEC_CDM	Chained Security telegram.
RADIO_CHOICE_SEC_MAINTENANCE	Maintenance security.
RADIO_CHOICE_SEC_TI	Secure teach-in telegram.
RADIO_CHOICE_GP_TEACH_IN	GP teach-in request.
RADIO_CHOICE_GP_COMPLETE	GP complete data.

enum RADIO_TEL_LENGTH

Length of the radio telegrams.

Enumerator:

RADIO_DEC_LENGTH_RPS	RPS decoded telegram length in bytes.
RADIO_DEC_LENGTH_1BS	1BS decoded telegram length in bytes
RADIO_DEC_LENGTH_4BS	4BS decoded telegram length in bytes
RADIO_DEC_LENGTH_HRC	HRC decoded telegram length in bytes.
RADIO_DEC_LENGTH_SYS	SYS decoded telegram length in bytes.
RADIO_DEC_LENGTH_SYS_EX	SYS_EX decoded telegram length in bytes.
RADIO_DEC_LENGTH_SM_LRN_REQ	Smart ack learn request decoded telegram length in bytes.
RADIO_DEC_LENGTH_SM_LRN_ANS	Smart ack learn answer telegram length in bytes.
RADIO_DEC_LENGTH_SM_REC	Smart ack reclaim telegram length in bytes.
RADIO_DEC_LENGTH_SIGNAL	Signal telegram length in bytes.
RADIO_DEC_LENGTH_U2S	U2S decoded telegram length in bytes.
RADIO_DEC_LENGTH_T2S	T2S decoded telegram length iin bytes.

enum STATUS_MASK

Status byte masks.

Enumerator:

STATUS_CRC	Bitmask for masking CRC vs CHECKSUM in status byte.
STATUS_GENERATION	Bitmask for masking telegram generation bit in status byte.
STATUS_ASSIGNED	Bitmask for masking normal/unassigned bit in status byte.
STATUS_REPEATER	Bitmask for masking repeater / hop counter / path selection bits.

enum RADIO_INIT_PARAM

Radio init parameters.

Enumerator:

CFG_ANALOG0_RX	Configure analog0_rx chain and trigger download.
CFG_ALL	Configure all chains and trigger download.
CFG_ANALOG0	Configure analog0 chain and trigger download.