Docs

You are here:
HAL_PACKED Struct ReferenceBlock transfer

Definition of the RCMLINK_TEST_PER_REQUEST packet. More...

#include <rcm_block_transfer.h>

Detailed Description

Definition of the RCMLINK_TEST_PER_REQUEST packet.

Definition of a structure that identifies an SCOM device.

SCOM version record.

RCMLINK_NEIGHBORHOOD_INDICATION_CONFIRMATION packet definition

RCMLINK_SET_NEIGHBORHOOD_INDICATION_INTERVAL_CONFIRMATION packet definition

RCMLINK_SET_NEIGHBORHOOD_INDICATION_INTERVAL_REQUEST packet definition

RCMLINK_SLEEP_CONFIRMATION packet definition

RCMLINK_LOG_OUTPUT_CONFIRMATION packet definition

RCMLINK_LOG_OUTPUT_REQUEST packet definition

RCMLINK_NEIGBORHOOD_INDICATION packet header

Single record carried in the RCMLINK_NEIGBORHOOD_INDICATION packet.

RCMLINK_NETWORK_SHORT_ADDR_CONFIRMATION and RCMLINK_NETWORK_EXT_ADDR_CONFIRMATION packet definition

RCMLINK_GET_FIRMWARE_VERSION_CONFIRMATION packet definition

RCMLINK_GET_OUTPUT_POWER_LEVEL_CONFIRMATION packet definition

RCMLINK_GET_PHY_CONFIRMATION packet definition

RCMLINK_SET_PHY_REQUEST packet definition

RCMLINK_SET_ANTENNA_CONFIRMATION packet definition

RCMLINK_SET_ANTENNA_REQUEST packet definition

RCMLINK_SET_OUTPUT_POWER_LEVEL_REQUEST packet definition

RCMLINK_TEST_CONTINOUS_TRANSMIT_REQUEST packet definition

Definition of the RCMLINK_CONFIGURATION_REQUEST and RCMLINK_CONFIGURATION_CONFIRMATION packets.

Definition of the RCMLINK_START_NETWORKING_CONFIRMATION packet.

Definition of the RCMLINK_SET_UID_REQUEST packet.

Definition of the RCMLINK_GET_UID_CONFIRMATION packet.

Definition of the RCMLINK_NETWORK_STATE_CONFIRMATION packet.

Definition of the RCMLINK_NETWORK_STATE_INDICATION packet.

Definition of the RCMLINK_EP_REGISTER_REQUEST packet.

Definition of the RCMLINK_EP_REGISTER_CONFIRMATION packet.

Definition of the RCMLINK_ADD_TO_GROUP_REQUEST packet

Definition of the RCMLINK_CHILD_JOIN_INDICATION packet

Definition of the RCMLINK_DATA_REQUEST packet header.

Definition of the RCMLINK_DATA_CONFIRMATION packet.

Definition of the RCMLINK_DATA_INDICATION packet.

Definition of the RCMLINK_SAVE_CONFIGURATION_CONFIRMATION packet.

Definition of the RCMLINK_LOAD_CONFIGURATION_CONFIRMATION packet.

Definition of the RCMLINK_CLEAR_CONFIGURATION_CONFIRMATION packet.

Definition of RCM block transfer protocol header

Definition of RCM block transfer protocol standard packet

Definition of RCM block transfer control header

Data Structures

struct  HAL_PACKED
 node's firmware version More...
 

Data Fields

uint8_t deviceType
 device type More...
 
uint64_t extPANId
 
uint8_t addressingScheme
 
uint16_t nwkShortAddr
 Assigned short network address. More...
 
uint8_t status
 Status of the network join. More...
 
uint8_t maxPayloadSize
 Maximum payload size that fits in a single frame.
 
uint64_t uid
 64-bit device unique identifier (extended address)
 
uint8_t networkState
 network state (see RCMNetworkState)
 
uint8_t endpoint
 ID of the endpoint within the node to which this description refers. Application shall only use endpoints 1-239.
 
uint16_t appProfileId
 Profile that is supported on this endpoint.
 
uint16_t appDeviceId
 Device description supported on this endpoint.
 
uint8_t appDeviceVersion
 Version of the device description supported on this endpoint.
 
uint8_t appInClustersCount
 Number of input clusters supported on this endpoint.
 
uint8_t appOutClustersCount
 Number of output clusters supported on this endpoint.
 
uint8_t ep_no
 ID of the endpoint.
 
uint16_t nwkGroupAddr
 the 16-bit address of the group being added
 
uint8_t epNo
 the endpoint to which the given group is being added
 
uint64_t extAddr
 the 64-bit extended address of the child being joined More...
 
union {
   uint16_t   dstShortAddr
 short network address
 
   uint64_t   dstExtAddr
 extended address
 
dstAddr
 destination address
 
uint8_t addrMode
 addressing mode (see RCMAddressingMode)
 
uint8_t dstEpNo
 destination endpoint
 
uint8_t srcEpNo
 source endpoint
 
uint8_t profileID
 profile id
 
uint8_t clusterId
 cluster id
 
uint8_t radius
 message radius (number of hops to travel)
 
uint8_t reqACK
 request APS layer ack (1 – yes, 0 - no)
 
uint8_t dstAddrMode
 
struct HAL_PACKED::HAL_PACKED dstAddr
 
uint8_t srcAddrMode
 
struct HAL_PACKED::HAL_PACKED srcAddr
 
uint8_t clusterID
 
uint8_t lqi
 
int8_t rssi
 neighbor's signal strength
 
uint16_t prevHopAddr
 
uint32_t ID
 id of the test (should be unique) More...
 
uint16_t totalPackets
 number of packets to send in a test More...
 
uint16_t shortAddr
 destination of the test (short network address of the receiver) More...
 
uint32_t interval
 interval between packets More...
 
uint16_t successPackets
 number of packets successfully received by the receiver
 
uint16_t currentPacket
 test progress - number of packets currently sent
 
uint8_t mode
 output power test mode (see RCMOutputPowerTestMode)
 
uint8_t outputNo
 output number
 
int8_t powerLevel
 output power in dBm
 
int8_t antennaNo
 antenna number
 
int32_t channelPage
 channel page
 
int32_t channelMask
 channel mask
 
uint8_t verHi
 higher version number More...
 
uint8_t verLo
 lower version number More...
 
uint32_t revision
 revision number
 
uint16_t nwkAddr
 short network address matching the extended address More...
 
uint8_t depth
 neighbor's depth in the network
 
uint8_t relation
 The relationship between the neighbor and the current device.
 
struct HAL_PACKED::HAL_PACKED firmwareVersion
 
uint8_t neibCount
 number of neighbors
 
uint32_t upTime
 total activity time (in seconds) since last reset
 
uint16_t vBat
 battery voltage
 
RCMLINK_NeigborhoodIndicationHeader header
 header
 
RCMLINK_NeigborhoodIndicationRecord neighbor [CS_NEIB_TABLE_SIZE]
 neighborhood table
 
uint8_t logOutputEnabled
 controls if the log output is enabled (1) or not (0) More...
 
uint16_t revision
 protocol revision
 
SCOMVersion version
 SCOM version record.
 
uint32_t deviceClass
 Device class.
 
uint8_t deviceUID [16]
 Device unique identifier.
 
uint8_t transferID
 Unique transfer identifier.
 
uint16_t count
 Frame number.
 
RCMBTPacketHeader header
 Packet header.
 
uint8_t payload [RCMBT_MAX_PAYLOAD_SIZE]
 
uint16_t totalCount
 Number of frames to be received.
 
uint32_t totalSize
 Total size of block transfer data.
 
uint32_t checksum
 Checksum of transmitted data.
 

Field Documentation

uint8_t HAL_PACKED::addressingScheme

Short network addressing scheme. Possible values:

  • 0 Stochastic addressing. In this mode the short network address will be provided stochastically by the networking stack.
  • 1 Static addressing. In this mode the short network address is given explicitly by the nwkShortAddr field
uint8_t HAL_PACKED::deviceType

device type

sending node's device type

neighbor device type

Type of device. Possible options:

  • 0 = coordinator
  • 1 = router
  • 2 = end device
uint64_t HAL_PACKED::extAddr

the 64-bit extended address of the child being joined

extended address (UID) of the sending node

extended address of the neighbor

extended address (UID) matching the short network address

uint64_t HAL_PACKED::extPANId

64-bit Extended PAN identifier.

uint32_t HAL_PACKED::ID

id of the test (should be unique)

id of the test

uint32_t HAL_PACKED::interval

interval between packets

interval in seconds to wake up and send NeigborhoodIndication

uint8_t HAL_PACKED::logOutputEnabled

controls if the log output is enabled (1) or not (0)

status of the log output = enabled (1) or not (0)

uint16_t HAL_PACKED::nwkAddr

short network address matching the extended address

short network address of the sending node

uint16_t HAL_PACKED::nwkShortAddr

Assigned short network address.

the 16-bit address of the child being joined

Explicit short network address, used if addressingScheme field indicates static addressing.

uint16_t HAL_PACKED::shortAddr

destination of the test (short network address of the receiver)

short network address of the neighbor

uint8_t HAL_PACKED::status

Status of the network join.

status of the neighborhood indication transmission (0 - OK, !0 - failed)

status of the sleep = enabled (1) or not (0) or not enddevice (2)

resolution status (0 means success, !0 is failure)

status of the clear operation: 1 - OK, 0 - FAILED

status of the load operation: 1 - OK, 0 - FAILED

status of the save operation: 1 - OK, 0 - FAILED

status of message sending (0 - OK, !0 - failed)

registration status (0 means success, !0 is failure)

Status of the network leave.

uint16_t HAL_PACKED::totalPackets

number of packets to send in a test

total number of packets to send in the test

uint8_t HAL_PACKED::verHi

higher version number

version high number

uint8_t HAL_PACKED::verLo

lower version number

version low number

Go to Top