playerc_coopobject_t Struct Reference

Note: the structure describing the Cooperating Object's data packet is declared in Player. More...

#include <playerc.h>

Collaboration diagram for playerc_coopobject_t:
Collaboration graph

Detailed Description

Note: the structure describing the Cooperating Object's data packet is declared in Player.

Cooperating Object proxy data.

Public Attributes

playerc_device_t info
 Device info; must be at the start of all device structures. More...
 
int messageType
 Flag to indicate that new info has come. More...
 
uint8_t origin
 The type of Cooperating Object. More...
 
uint16_t id
 Cooperating Object ID.
 
uint16_t parent_id
 Cooperating Object Parent ID (if existing)
 
uint16_t RSSIsender
 Cooperating Object data packet. More...
 
uint16_t RSSIvalue
 
uint16_t RSSIstamp
 
uint32_t RSSInodeTimeHigh
 
uint32_t RSSInodeTimeLow
 
float x
 Cooperating Object Position. More...
 
float y
 
float z
 
uint8_t status
 
uint32_t sensor_data_count
 Number of sensors included.
 
player_coopobject_sensor_tsensor_data
 Sensor measurements array. More...
 
uint32_t alarm_data_count
 Number of alarms included.
 
player_coopobject_sensor_talarm_data
 Active alarms array. More...
 
uint32_t user_data_count
 User defined message size (in bytes)
 
uint8_t * user_data
 User defined data array. More...
 
uint8_t command
 Command type. More...
 
uint8_t request
 Request type. More...
 
uint32_t parameters_count
 Request/command parameters array size (in bytes)
 
uint8_t * parameters
 Request/command parameters array.
 

Member Data Documentation

◆ alarm_data

player_coopobject_sensor_t* playerc_coopobject_t::alarm_data

Active alarms array.

1 if active, 0 if inactive or no alarm read. Up to 255 Alarms

Referenced by PlayerCc::CoopObjectProxy::GetAlarmData(), and PlayerCc::CoopObjectProxy::GetAlarmType().

◆ command

uint8_t playerc_coopobject_t::command

Command type.

Default: 0 (status). Up to 255 different command types

Referenced by PlayerCc::CoopObjectProxy::GetCommand().

◆ info

playerc_device_t playerc_coopobject_t::info

Device info; must be at the start of all device structures.

◆ messageType

int playerc_coopobject_t::messageType

Flag to indicate that new info has come.

If WSN_NONE (-1), old info which should be discarded

Referenced by PlayerCc::CoopObjectProxy::MessageType().

◆ origin

uint8_t playerc_coopobject_t::origin

The type of Cooperating Object.

0 PLAYER_COOPOBJECT_ORIGIN_STATICBASE 1 PLAYER_COOPOBJECT_ORIGIN_MOBILEBASE 2 PLAYER_COOPOBJECT_ORIGIN_MOTE 3 PLAYER_COOPOBJECT_ORIGIN_ROBOT

Referenced by PlayerCc::CoopObjectProxy::GetOrigin().

◆ request

uint8_t playerc_coopobject_t::request

Request type.

Default: 0 (status). Up to 255 different request types

Referenced by PlayerCc::CoopObjectProxy::GetRequest().

◆ RSSIsender

uint16_t playerc_coopobject_t::RSSIsender

Cooperating Object data packet.

Radio Signal Strength measurement. All fields 0 if no value read

Referenced by PlayerCc::CoopObjectProxy::GetRSSIsenderId().

◆ sensor_data

player_coopobject_sensor_t* playerc_coopobject_t::sensor_data

Sensor measurements array.

Up to 255 sensors. -1 if no read value or no sensor

Referenced by PlayerCc::CoopObjectProxy::GetSensorData(), and PlayerCc::CoopObjectProxy::GetSensorType().

◆ user_data

uint8_t* playerc_coopobject_t::user_data

User defined data array.

Up to 255 fields

Referenced by PlayerCc::CoopObjectProxy::GetAllUserData(), and PlayerCc::CoopObjectProxy::GetUserData().

◆ x

float playerc_coopobject_t::x

Cooperating Object Position.

All fields 0 if no value read

Referenced by PlayerCc::CoopObjectProxy::GetX().


The documentation for this struct was generated from the following file: