OpenPassingStream
Requests
A PassingRequest requests old and/or future passings or requests the stream of passings to stop.
It also allows to acknowledge received passings.
Sending a new get request will stop any other ongoing get request in the stream.
| Field | Type | Label | Description |
| get | CmdGetPassings |
request passings |
|
| stop | CmdStopPassings |
stop the current stream of passings |
|
| ack | CmdAckPassing |
acknowledge received passings |
Responses
OpenStatusStream
Requests
A StatusRequest requests the current status (and future status updates) or requests the stream of status updates to stop.
Sending a new get request will stop any other ongoing get request in the stream.
| Field | Type | Label | Description |
| get | CmdGetStatus |
request status (updates) |
|
| stop | CmdStopStatus |
stop the current stream of status updates |
Responses
OpenCommandStream
Requests
A CommandRequest executes a command on the Ubidium.
| Field | Type | Label | Description |
| id | uint32 |
unique ID of the command request, will be returned with the command response |
|
| new_file | CmdNewFile |
creates a new file |
|
| set_time | CmdSetTime |
sets the time |
|
| get_screen | CmdGetScreen |
gets screen contents |
|
| press_key | CmdPressKey |
simulates a key press |
|
| get_settings | CmdGetSettings |
gets settings |
|
| set_settings | CmdSetSettings |
sets settings |
|
| reboot | CmdReboot | reboots system | |
| ping | CmdPing | keep connection alive |
Responses
A CommandResponse is a response to a CommandRequest.
| Field | Type | Label | Description |
| request_id | uint32 |
unique ID which was given with the request |
|
| error | Error |
error |
|
| new_file_response | CmdNewFileResponse |
response to a new_file command |
|
| set_time_response | CmdSetTimeResponse |
response to a set_time command |
|
| get_screen_response | CmdGetScreenResponse |
response to a get_screen command |
|
| press_key_response | CmdPressKeyResponse |
response to a press_key command |
|
| get_settings_response | CmdGetSettingsResponse |
response to a get_settings command |
|
| set_settings_response | CmdSetSettingsResponse |
response to a set_settings command |
|
| reboot_response | CmdRebootResponse | response to a reboot command | |
| pong | CmdPong | response to a ping command |
OpenPrewarnStream
Requests
A PrewarnRequest tells the Ubidium to send Prewarns from now on.
Responses
NewFile
CmdNewFile
CmdNewFile starts a new file.
CmdNewFileResponse
CmdNewFileResponse is the response to a CmdNewFile call.
| Field | Type | Label | Description |
| file_no | uint32 |
file number of the newly created file |
SetTime
CmdSetTime
CmdSetTime sets the time.
| Field | Type | Label | Description |
| automatic | CmdSetTime.Source |
set time automatically via GPS or NTP |
|
| manual | Time |
set time manually to a specific value. Always set the time to the correct value. |
CmdSetTimeResponse
CmdSetTimeResponse is the response to a CmdSetTime call.
| Field | Type | Label | Description |
| time | Time |
time of the system when generating the response |
|
| source | CmdSetTimeResponse.Source |
source used to set the time |
CmdSetTime.Source
A Source says which time source should be used to set the time
| Name | Number | Description |
| SOURCE_UNSPECIFIED | 0 |
|
| SOURCE_GPS_OR_NTP | 1 |
set time via GPS if available, otherwise use NTP |
| SOURCE_GPS | 2 |
set time via GPS |
| SOURCE_NTP | 3 |
set time using NTP |
CmdSetTimeResponse.Source
Source tells which time source was used to set the time
| Name | Number | Description |
| SOURCE_UNSPECIFIED | 0 |
|
| SOURCE_MANUAL | 1 |
time set using given time |
| SOURCE_GPS | 2 |
time set using GPS |
| SOURCE_NTP | 3 |
time set using NTP |
GetScreen
CmdGetScreen
CmdGetScreen returns the current display contents as an image.
CmdGetScreenResponse
CmdGetScreenResponse is the response to a CmdGetScreen call.
| Field | Type | Label | Description |
| image | bytes |
screen contents as a PNG image |
PressKey
CmdPressKey
CmdPressKey simulates a key press.
| Field | Type | Label | Description |
| key | Key |
key to be pressed |
CmdPressKeyResponse
CmdPressKeyResponse is the response to a CmdPressKey call.
Key
Key specifies a key of the Ubidium keypad.
| Name | Number | Description |
| KEY_UNSPECIFIED | 0 |
|
| KEY_OK | 28 |
OK |
| KEY_BACK | 14 |
back/menu key |
| KEY_UP | 103 |
up arrow |
| KEY_DOWN | 108 |
down arrow |
| KEY_LEFT | 105 |
left key |
| KEY_RIGHT | 106 |
right key |
| KEY_SCREEN_1 | 59 |
counting from top, first key next to the screen |
| KEY_SCREEN_2 | 60 |
counting from top, second key next to the screen |
| KEY_SCREEN_3 | 61 |
counting from top, third key next to the screen |
| KEY_SCREEN_4 | 62 |
counting from top, fourth key next to the screen |
| KEY_START | 88 |
START |
GetSettings
CmdGetSettings
CmdGetSettings gets a number of settings.
| Field | Type | Label | Description |
| keys | string | repeated |
list of settings to be fetched |
CmdGetSettingsResponse
CmdGetSettingsResponse is a response to a CmdGetSettings command.
| Field | Type | Label | Description |
| settings | Setting | repeated |
list of settings |
Setting
Setting is a setting with a key (name) and value.
Currently valid keys are:
| General.Name | string_val | |
| Active.Internal.Channel | int_val | |
| Active.Internal.LoopID | int_val | |
| Active.Internal.Power | int_val | |
| Display.Backlight.Brightness | int_val | 0,10,50,100 |
| LEDs.Brightness | int_val | 0,10,50,100 |
| Detection.Indicator | string_val | Nothing,Beep,Blink,Beep+Blink |
| Network.Ethernet.Method | string_val | auto,manual |
| Network.Ethernet.IP | string_val | |
| Network.Ethernet.Netmask | string_val | |
| Network.Ethernet.Gateway | string_val | |
| Network.Ethernet.DNS | string_val | |
| Network.WIFI.Mode | string_val | Client,Access Point,Off |
| Network.Mobile.SIM | string_val | internal,external |
| Network.Mobile.SIMExternal.PIN | string_val | |
| Network.Mobile.SIMExternal.Method | string_val | auto,manual |
| Network.Mobile.SIMExternal.Method.Provider.APN | string_val | |
| Network.Mobile.SIMExternal.Method.Provider.User | string_val | |
| Network.Mobile.SIMExternal.Method.Provider.Password | string_val | |
| Network.Mobile.ExternalAntenna | bool_val | |
| Network.Cloud.CustNo | int_val | |
| Network.Cloud.EnableOnStartup | bool_val | |
| Time.Zone | string_val | |
| Trigger.MarkerNo | int_val | |
| Trigger.IncMarkerNo | bool_val |
| Field | Type | Label | Description |
| key | string |
name of the setting |
|
| int_val | int32 |
value of the setting if it is an int |
|
| string_val | string |
value of the setting if it is a string |
|
| bool_val | bool |
value of the setting if it is a bool |
|
| duration_val | google.protobuf.Duration |
value of the setting if it is a duration |
SetSettings
CmdSetSettings
CmdSetSettings sets a number of settings.
| Field | Type | Label | Description |
| settings | Setting | repeated |
list of settings |
CmdSetSettingsResponse
CmdSetSettingsResponse is a response to a CmdSetSettings command.
| Field | Type | Label | Description |
| settings | Setting | repeated |
list of (updated) settings |
Reboot
CmdReboot
CmdReboot triggers a reboot of the system.
CmdRebootResponse
CmdRebootResponse is the response to a CmdReboot call.
Ping
CmdPing
CmdPing can be used to keep the connection alive.
CmdPong
CmdPong is the response to a CmdPing call.