Status
Status represents a status (update) message.
| Field | Type | Label | Description |
| time | Time |
Ubidium's time when the status message was generated |
|
| id | string | optional |
device ID |
| name | string | optional |
name |
| version | string | optional |
Firmware version |
| cust_no | uint32 | optional |
configured customer number |
| passing_id | uint64 | optional |
ID of most current passing |
| passing_no | Status.PassingNo | optional |
number of most current passing |
| active_internal | Status.Active | optional |
internal active status |
| passive | Status.Passive | optional |
Status of the connected passive equipment |
| gps | Status.GPS | optional |
GPS status |
| battery_slot1 | Status.BatterySlot | optional |
status of battery slot 1 |
| battery_slot2 | Status.BatterySlot | optional |
status of battery slot 2 |
| temperature | double | optional |
current temperature (measured on the main board) |
| power | Status.Power | optional |
power status |
Status.Active
Status of an active device
| Field | Type | Label | Description |
| self | Status.Active.Beacon |
our beacon data |
|
| others | Status.Active.OthersEntry | repeated |
other known beacon data, key is ID |
Status.Active.Beacon
Beacon
| Field | Type | Label | Description |
| channel | uint32 | optional |
loop channel |
| loop_id | uint32 | optional |
loop ID |
| power | uint32 | optional |
loop power |
| loop_status | uint32 | optional |
loop status |
| last_seen | Time | optional |
beacon time |
| mode | uint32 | optional |
mode |
| power_con | uint32 | optional |
power con |
| power_status | uint32 | optional |
power status |
| beacon_index | uint32 | optional |
beacon index |
| ch_noise_avg | uint32 | optional |
channel noise average |
| trans_lqi | uint32 | optional |
transponder LQI |
| trans_energy_detect | uint32 | optional |
transponder energy detect |
| beacon_lqi | uint32 | optional |
beacon LQI |
| beacon_energy_detect | uint32 | optional |
beacon energy detect |
| mode_box | uint32 | optional |
beacon box mode |
| temperature | int32 | optional |
temperature |
Status.Active.OptionalBeacon
OptionalBeacon is an optional beacon
| Field | Type | Label | Description |
| beacon | Status.Active.Beacon | optional |
beacon |
Status.Active.OthersEntry
| Field |
Type |
Label | Description |
| key | uint32 |
|
|
| value | Status.Active.OptionalBeacon |
|
Status.Passive
Status of passive equipment
| Field | Type | Label | Description |
| elements | Status.Passive.ElementsEntry | repeated |
known element data, key is ID |
Status.Passive.Element
Status of a single antenna element
| Field | Type | Label | Description |
| position | uint32 | optional |
element position |
| string_no | uint32 | optional |
string number the element is part of |
| status | ElementStatus | optional |
element status |
Status.Passive.ElementsEntry
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Status.Passive.OptionalElement |
|
Status.Passive.OptionalElement
OptionalElement is an optional element
| Field | Type | Label | Description |
| element | Status.Passive.Element | optional |
element |
Status.BatteryData
Status of a battery
| Field | Type | Label | Description |
| level | uint32 | optional |
power level |
| remaining | google.protobuf.Duration | optional |
time until full if charging, time until empty if discharging |
| state | BatteryState | optional |
charging state of the battery |
ElementStatus
ElementStatus represents the status of a passive antenna element
| Name | Number | Description |
| ELEMENT_STATUS_UNKNOWN | 0 |
Element status is unknown |
| ELEMENT_STATUS_OK | 1 |
Element is OK |
| ELEMENT_STATUS_BAD | 2 |
Element reports bad RSSI |
| ELEMENT_STATUS_MUTE | 3 |
Element is muted |
| ELEMENT_STATUS_UNAVAILABLE | 4 |
Element is unavailable |
Status.BatterySlot
A BatterySlot is either empty or has a battery (with its values)
| Field | Type | Label | Description |
| empty | bool |
|
|
| battery | Status.BatteryData |
|
Status.GPS
GPS has either a fix with location or no_fix
| Field | Type | Label | Description |
| no_fix | bool |
set if there is no GPS fix |
|
| location | Location |
set to the location if there is GPS reception |
Status.PassingNo
Passing and/or file number
| Field | Type | Label | Description |
| file | uint32 | optional |
|
| no | uint32 | optional |
|
Status.Power
Status of power supply
| Field | Type | Label | Description |
| source | PowerSource | optional |
(additional) source of power |
BatteryState
BatteryState represents the current charging state of the battery
| Name | Number | Description |
| BATTERY_STATE_UNSPECIFIED | 0 |
|
| BATTERY_STATE_DISCHARGING | 1 |
battery is currently discharging |
| BATTERY_STATE_CHARGING | 2 |
battery is currently charging |
| BATTERY_STATE_IDLE | 3 |
battery is idle (i.e. not charging or discharging) |
PowerSource
PowerSource represents the current power source.
| Name | Number | Description |
| POWER_SOURCE_UNSPECIFIED | 0 |
|
| POWER_SOURCE_NONE | 1 |
no additional power source is used |
| POWER_SOURCE_AC | 2 |
AC is used as power source. (Battery might be used additionally.) |
| POWER_SOURCE_DC | 3 |
DC is used as power source. (Battery might be used additionally.) |
| POWER_SOURCE_USBPD | 4 |
USBPD is used as power source. (Battery might be used additionally.) |
| POWER_SOURCE_POE | 5 |
POE is used as power source. (Battery might be used additionally.) |