package P4wnP1_grpc

string scriptName = 1
could be combined into oneof with script path, to allow starting scripts from arbitrary filepath (avoids storing scripts in DB or fixed folder)

Used as request type in: P4WNP1.DeployBluetoothAgentSettings

Used as response type in: P4WNP1.DeployBluetoothAgentSettings, P4WNP1.GetBluetoothAgentSettings

Used as field type in: BluetoothSettings

string pin = 1

Used as request type in: P4WNP1.DeployBluetoothControllerInformation

Used as response type in: P4WNP1.DeployBluetoothControllerInformation, P4WNP1.GetBluetoothControllerInformation

Used as field type in: BluetoothSettings

bytes address = 1
uint32 bluetooth_version = 2
uint32 manufacturer = 3
optional BluetoothControllerSettings supported_settings = 4
optional BluetoothControllerSettings current_settings = 5
bytes class_of_device = 6
string name = 7
string short_name = 8
bool is_available = 9
bool service_network_server_nap = 10
bool service_network_server_panu = 11
bool service_network_server_gn = 12

Used in: BluetoothControllerInformation

bool powered = 1
bool connectable = 2
bool fast_connectable = 3
bool discoverable = 4
bool bondable = 5
bool link_level_security = 6
bool secure_simple_pairing = 7
bool br_edr = 8
bool high_speed = 9
bool low_energy = 10
bool advertising = 11
bool secure_connections = 12
bool debug_keys = 13
bool privacy = 14
bool controller_configuration = 15
bool static_address = 16

Used in: BluetoothNetworkService

NAP = 0
PANU = 1
GN = 2

Used as request type in: P4WNP1.DeployBluetoothSettings

Used as response type in: P4WNP1.DeployBluetoothSettings, P4WNP1.DeployStoredBluetoothSettings, P4WNP1.GetStoredBluetoothSettings

Used as field type in: BluetoothRequestSettingsStorage

optional BluetoothControllerInformation ci = 1
Parts interpreted as settings: current_settings, name, service_network_server_nap, service_network_server_panu, service_network_server_gn
optional BluetoothAgentSettings as = 2

Could be used for IPv4 or IPv6 (refer dnsmasq docs), nor field for prefix length (default is 64)

Used in: DHCPServerSettings

string rangeLower = 1
Lowest IP of DHCP range
string rangeUpper = 2
Highest IP of DHCP range
string leaseTime = 3

DHCP

Used in: EthernetInterfaceSettings

uint32 listenPort = 1
if a port other thaan 0 is provided, a DNS server is bound to this port in addition to DHCP
string listenInterface = 2
string leaseFile = 3
bool notAuthoritative = 4
bool doNotBindInterface = 5
if true, DHCP server binds to 0.0.0.0, no matter which interface is given (no restart needed on interface up/down)
string callbackScript = 6
Script executes when lease is added/deleted `scriptname <add|del> <MAC> <IP> <HOSTNAME>`
repeated DHCPServerRange ranges = 7
map<uint32, string> options = 8
repeated DHCPServerOption options = 8;
Replaced by map (dealing with key duplicates is ONLY PARTIALY handled by proto3), See RFC 2132 for details of available options
repeated DHCPServerStaticHost staticHosts = 9

Used for static leases

Used in: DHCPServerSettings

string mac = 1
string ip = 2

Used as request type in: P4WNP1.GetAllDeployedEthernetInterfaceSettings, P4WNP1.GetAvailableGpios, P4WNP1.GetBluetoothAgentSettings, P4WNP1.GetBluetoothControllerInformation, P4WNP1.GetDeployedGadgetSetting, P4WNP1.GetDeployedTriggerActionSet, P4WNP1.GetLEDSettings, P4WNP1.GetStartupMasterTemplate, P4WNP1.GetWiFiState, P4WNP1.HIDCancelAllScriptJobs, P4WNP1.HIDGetRunningScriptJobs, P4WNP1.ListStoredBashScripts, P4WNP1.ListStoredBluetoothSettings, P4WNP1.ListStoredDBBackups, P4WNP1.ListStoredEthernetInterfaceSettings, P4WNP1.ListStoredHIDScripts, P4WNP1.ListStoredMasterTemplate, P4WNP1.ListStoredTriggerActionSets, P4WNP1.ListStoredUSBSettings, P4WNP1.ListStoredWifiSettings, P4WNP1.ListUmsImageCdrom, P4WNP1.ListUmsImageFlashdrive, P4WNP1.ListenWiFiStateChanges, P4WNP1.Reboot, P4WNP1.Shutdown

Used as response type in: P4WNP1.DBBackup, P4WNP1.DBRestore, P4WNP1.DeleteStoredBluetoothSettings, P4WNP1.DeleteStoredEthernetInterfaceSettings, P4WNP1.DeleteStoredMasterTemplate, P4WNP1.DeleteStoredTriggerActionSet, P4WNP1.DeleteStoredUSBSettings, P4WNP1.DeleteStoredWifiSettings, P4WNP1.DeployEthernetInterfaceSettings, P4WNP1.DeployMasterTemplate, P4WNP1.DeployStoredEthernetInterfaceSettings, P4WNP1.FSWriteFile, P4WNP1.FireActionGroupSend, P4WNP1.HIDCancelAllScriptJobs, P4WNP1.HIDCancelScriptJob, P4WNP1.MountUMSFile, P4WNP1.Reboot, P4WNP1.SetBluetoothNetworkService, P4WNP1.SetLEDSettings, P4WNP1.SetStartupMasterTemplate, P4WNP1.Shutdown, P4WNP1.StoreBluetoothSettings, P4WNP1.StoreDeployedBluetoothSettings, P4WNP1.StoreDeployedUSBSettings, P4WNP1.StoreDeployedWifiSettings, P4WNP1.StoreEthernetInterfaceSettings, P4WNP1.StoreMasterTemplate, P4WNP1.StoreTriggerActionSet, P4WNP1.StoreUSBSettings, P4WNP1.StoreWifiSettings, P4WNP1.WaitTriggerGroupReceive

(message has no fields)

Used as request type in: P4WNP1.DeployEthernetInterfaceSettings

Used as response type in: P4WNP1.GetDeployedEthernetInterfaceSettings, P4WNP1.GetStoredEthernetInterfaceSettings

Used as field type in: DeployedEthernetInterfaceSettings, EthernetRequestSettingsStorage

string name = 1
EthernetInterfaceSettings.Mode mode = 2
string ipAddress4 = 3
string netmask4 = 4
bool enabled = 5
optional DHCPServerSettings dhcpServerSettings = 6
bool settingsInUse = 7
indicates if the given settings are applied to the interface

Used in: EthernetInterfaceSettings

MANUAL = 0
DHCP_CLIENT = 1
DHCP_SERVER = 2
UNMANAGED = 3
Indicates that the settings aren't known, as they aren't managed by the service

Used in: Event

oneof val
- string tstring = 1
- bool tbool = 2
- int64 tint64 = 3

Used in: TriggerGPIOIn

RISING = 0
FALLING = 1
BOTH = 2

Used in: TriggerGPIOIn

UP = 0
DOWN = 1
OFF = 2

Used in: ActionGPIOOut

LOW = 0
HIGH = 1
TOGGLE = 2

Used as request type in: P4WNP1.DeployGadgetSetting

Used as response type in: P4WNP1.DeployGadgetSetting, P4WNP1.DeployStoredUSBSettings, P4WNP1.GetDeployedGadgetSetting, P4WNP1.GetStoredUSBSettings

Used as field type in: USBRequestSettingsStorage

bool enabled = 1
string vid = 2
string pid = 3
string manufacturer = 4
string product = 5
string serial = 6
bool use_CDC_ECM = 7
bool use_RNDIS = 8
bool use_HID_KEYBOARD = 9
bool use_HID_MOUSE = 10
bool use_HID_RAW = 11
bool use_UMS = 12
bool use_SERIAL = 13
optional GadgetSettingsEthernet rndis_settings = 14
Only applicable if RNDIS on
optional GadgetSettingsEthernet cdc_ecm_settings = 15
Only applicable if CDC ECM on
optional GadgetSettingsUMS ums_settings = 16
string dev_path_hid_keyboard = 18
EthernetInterfaceSettings ethernet_settings = 17; //only applicable if RNDIS or CDC ECM on
string dev_path_hid_mouse = 19
string dev_path_hid_raw = 20

Used in: GadgetSettings

string host_addr = 1
string dev_addr = 2

Used as request type in: P4WNP1.MountUMSFile

Used as field type in: GadgetSettings

bool cdrom = 1
string file = 2

Used in: TriggerGroupReceiveMulti

SEQUENCE = 0
values have to occur in order (other values allowed in between)
AND = 1
logical and ("all" values have to occur, could be unordered)
OR = 2
logical or ("one of" the values has to occur)
EXACT_SEQUENCE = 3
values have to occur in order (other values are NOT allowed in between)

Used as request type in: P4WNP1.HIDCancelScriptJob, P4WNP1.HIDGetRunningJobState, P4WNP1.HIDGetScriptJobResult

Used as response type in: P4WNP1.HIDRunScriptJob

Used as field type in: HIDScriptResult

uint32 id = 1

HID

Used as request type in: P4WNP1.HIDRunScript, P4WNP1.HIDRunScriptJob

string scriptPath = 1
uint32 timeoutSeconds = 2
a timeout > 0 interrupts the HIDScript when reached, meassurement in seconds

Used as response type in: P4WNP1.HIDGetScriptJobResult, P4WNP1.HIDRunScript

optional HIDScriptJob job = 1
bool isFinished = 2
string resultJson = 3
string logOutput = 4; //will be used to retrieve log output of unfinished scripts, better implemented in dedicated method with stream

LED

Used as request type in: P4WNP1.SetLEDSettings

Used as response type in: P4WNP1.GetLEDSettings

uint32 blink_count = 1

MasterTemplates

Used as request type in: P4WNP1.DeployMasterTemplate

Used as response type in: P4WNP1.DeployStoredMasterTemplate, P4WNP1.GetStoredMasterTemplate

Used as field type in: RequestMasterTemplateStorage

string template_name_bluetooth = 1
string template_name_usb = 2
string template_name_wifi = 3
string template_name_trigger_actions = 4
repeated string template_names_network = 5

Alive check

Used as request type in: P4WNP1.DBBackup, P4WNP1.DBRestore, P4WNP1.DeleteStoredBluetoothSettings, P4WNP1.DeleteStoredEthernetInterfaceSettings, P4WNP1.DeleteStoredMasterTemplate, P4WNP1.DeleteStoredTriggerActionSet, P4WNP1.DeleteStoredUSBSettings, P4WNP1.DeleteStoredWifiSettings, P4WNP1.DeployStoredBluetoothSettings, P4WNP1.DeployStoredEthernetInterfaceSettings, P4WNP1.DeployStoredMasterTemplate, P4WNP1.DeployStoredTriggerActionSetAdd, P4WNP1.DeployStoredTriggerActionSetReplace, P4WNP1.DeployStoredUSBSettings, P4WNP1.DeployStoredWifiSettings, P4WNP1.EchoRequest, P4WNP1.GetDeployedEthernetInterfaceSettings, P4WNP1.GetStoredBluetoothSettings, P4WNP1.GetStoredEthernetInterfaceSettings, P4WNP1.GetStoredMasterTemplate, P4WNP1.GetStoredUSBSettings, P4WNP1.GetStoredWifiSettings, P4WNP1.SetStartupMasterTemplate, P4WNP1.StoreDeployedBluetoothSettings, P4WNP1.StoreDeployedUSBSettings, P4WNP1.StoreDeployedWifiSettings

Used as response type in: P4WNP1.EchoRequest, P4WNP1.GetStartupMasterTemplate

string msg = 1

Used as response type in: P4WNP1.GetAvailableGpios, P4WNP1.ListStoredBashScripts, P4WNP1.ListStoredBluetoothSettings, P4WNP1.ListStoredDBBackups, P4WNP1.ListStoredEthernetInterfaceSettings, P4WNP1.ListStoredHIDScripts, P4WNP1.ListStoredMasterTemplate, P4WNP1.ListStoredTriggerActionSets, P4WNP1.ListStoredUSBSettings, P4WNP1.ListStoredWifiSettings, P4WNP1.ListUmsImageCdrom, P4WNP1.ListUmsImageFlashdrive

repeated string msgArray = 1

Used in: TriggerActionSet

uint32 id = 1
assigned by service, used as identifier to allow deletion of trigger actions
bool oneShot = 2
bool isActive = 3
bool immutable = 4
oneof Trigger
- TriggerServiceStarted serviceStarted = 5
- TriggerUSBGadgetConnected usbGadgetConnected = 6
- TriggerUSBGadgetDisconnected usbGadgetDisconnected = 7
- TriggerWifiAPStarted wifiAPStarted = 8
- TriggerWifiConnectedAsSta wifiConnectedAsSta = 9
- TriggerSSHLogin sshLogin = 10
- TriggerDHCPLeaseGranted dhcpLeaseGranted = 11
- TriggerGroupReceive groupReceive = 12
- TriggerGroupReceiveMulti groupReceiveMulti = 13
- TriggerGPIOIn gpioIn = 14
oneof Action
- ActionStartBashScript bashScript = 15
- ActionStartHIDScript hidScript = 16
- ActionDeploySettingsTemplate deploySettingsTemplate = 17
- ActionLog log = 18
- ActionGPIOOut gpioOut = 19
- ActionGroupSend groupSend = 20

Triggers, Actions and resulting TriggerActions

Used as request type in: P4WNP1.DeployTriggerActionSetAdd, P4WNP1.DeployTriggerActionSetRemove, P4WNP1.DeployTriggerActionSetReplace, P4WNP1.DeployTriggerActionSetUpdate, P4WNP1.StoreTriggerActionSet

Used as response type in: P4WNP1.DeployStoredTriggerActionSetAdd, P4WNP1.DeployStoredTriggerActionSetReplace, P4WNP1.DeployTriggerActionSetAdd, P4WNP1.DeployTriggerActionSetRemove, P4WNP1.DeployTriggerActionSetReplace, P4WNP1.DeployTriggerActionSetUpdate, P4WNP1.GetDeployedTriggerActionSet

repeated TriggerAction TriggerActions = 1
string Name = 2

Used in: TriggerAction

(message has no fields)

Used in: TriggerAction

string gpio_name = 1
GPIOInPullUpDown pullUpDown = 2
GPIOInEdge gpioInEdge = 3
int64 debounce_millis = 4

fired when the correct value is received on the group channel

Used as request type in: P4WNP1.WaitTriggerGroupReceive

Used as field type in: TriggerAction

string groupName = 1
int32 value = 2

Used in: TriggerAction

string groupName = 1
repeated int32 values = 3
GroupReceiveMultiType type = 4

fired when a user logs in

Used in: TriggerAction

string loginUser = 1

Used in: TriggerAction

(message has no fields)

Used in: TriggerAction

(message has no fields)

Used in: TriggerAction

(message has no fields)

Used in: TriggerAction

(message has no fields)

Used in: TriggerAction

(message has no fields)

Used in: WiFiSettings

WPA2_PSK = 0
AP uses WPA2 pre-shared key
OPEN = 1
Open System Authentication (no authentication)

Used in: WiFiSettings

string SSID = 1
string PSK = 2

Used as request type in: P4WNP1.DeployWiFiSettings

Used as response type in: P4WNP1.GetStoredWifiSettings

Used as field type in: WiFiState, WifiRequestSettingsStorage

string name = 1
Generic
for template storage
bool disabled = 2
disabled means neither hostapd, nor wpa_supplicant are running, the interface could still be enabled
string regulatory = 3
Regulatory domain per ISO/IEC 3166-1 alpha2
WiFiWorkingMode working_mode = 4
WiFiAuthMode auth_mode = 5
uint32 channel = 6
optional WiFiBSSCfg ap_BSS = 7
SSID of AP to spawn + PSK if needed
repeated WiFiBSSCfg client_BSS_list = 8
SSID of Infra to join + PSK if needed
bool hide_ssid = 9
if true, SSID gets hidden for spawned AP
bool nexmon = 13

Used as response type in: P4WNP1.DeployStoredWifiSettings, P4WNP1.DeployWiFiSettings, P4WNP1.GetWiFiState, P4WNP1.ListenWiFiStateChanges

WiFiStateMode mode = 1
uint32 channel = 2
string ssid = 3
SSID currently connected (STA) or spawned (AP)
optional WiFiSettings currentSettings = 4

Used in: WiFiState

STA_NOT_CONNECTED = 0
AP_UP = 1
acts as access point
STA_CONNECTED = 2
acts as station for an existing access point

WiFi2 (distinguish state and settings)

Used in: WiFiSettings

UNKNOWN = 0
AP = 1
acts as access point
STA = 2
acts as station for an existing access point
STA_FAILOVER_AP = 3
acts as station, if connection to the given AP isn't possible spawns an own AP

package P4wnP1_grpc

service P4WNP1

rpc GetBluetoothControllerInformation (Empty, BluetoothControllerInformation)

rpc DeployBluetoothControllerInformation (BluetoothControllerInformation, BluetoothControllerInformation)

rpc GetBluetoothAgentSettings (Empty, BluetoothAgentSettings)

rpc DeployBluetoothAgentSettings (BluetoothAgentSettings, BluetoothAgentSettings)

rpc SetBluetoothNetworkService (BluetoothNetworkService, Empty)

message BluetoothNetworkService

bool register_or_unregister = 1

bool server_or_connect = 2

BluetoothNetworkServiceType type = 3

string mac_or_name = 4

string bridge_name = 5

rpc DeployBluetoothSettings (BluetoothSettings, BluetoothSettings)

rpc StoreBluetoothSettings (BluetoothRequestSettingsStorage, Empty)

message BluetoothRequestSettingsStorage

string TemplateName = 1

optional BluetoothSettings settings = 2

rpc GetStoredBluetoothSettings (StringMessage, BluetoothSettings)

rpc DeployStoredBluetoothSettings (StringMessage, BluetoothSettings)

rpc DeleteStoredBluetoothSettings (StringMessage, Empty)

rpc StoreDeployedBluetoothSettings (StringMessage, Empty)

rpc ListStoredBluetoothSettings (Empty, StringMessageArray)

rpc GetDeployedGadgetSetting (Empty, GadgetSettings)

rpc DeployGadgetSetting (GadgetSettings, GadgetSettings)

rpc GetLEDSettings (Empty, LEDSettings)

rpc SetLEDSettings (LEDSettings, Empty)

rpc MountUMSFile (GadgetSettingsUMS, Empty)

rpc StoreUSBSettings (USBRequestSettingsStorage, Empty)

message USBRequestSettingsStorage

string TemplateName = 1

optional GadgetSettings settings = 2

rpc GetStoredUSBSettings (StringMessage, GadgetSettings)

rpc DeployStoredUSBSettings (StringMessage, GadgetSettings)

rpc DeleteStoredUSBSettings (StringMessage, Empty)

rpc StoreDeployedUSBSettings (StringMessage, Empty)

rpc ListStoredUSBSettings (Empty, StringMessageArray)

rpc ListUmsImageCdrom (Empty, StringMessageArray)

rpc ListUmsImageFlashdrive (Empty, StringMessageArray)

rpc HIDRunScript (HIDScriptRequest, HIDScriptResult)

rpc HIDRunScriptJob (HIDScriptRequest, HIDScriptJob)

rpc HIDGetScriptJobResult (HIDScriptJob, HIDScriptResult)

rpc HIDCancelScriptJob (HIDScriptJob, Empty)

rpc HIDGetRunningScriptJobs (Empty, HIDScriptJobList)

message HIDScriptJobList

repeated uint32 ids = 1

rpc HIDCancelAllScriptJobs (Empty, Empty)

rpc HIDGetRunningJobState (HIDScriptJob, HIDRunningJobStateResult)

message HIDRunningJobStateResult

int64 id = 1

int64 vmId = 2

string source = 3

rpc FSWriteFile (WriteFileRequest, Empty)

message WriteFileRequest

AccessibleFolder folder = 1

string filename = 2

bool append = 3

bool mustNotExist = 4

bytes data = 5

rpc FSReadFile (ReadFileRequest, ReadFileResponse)

message ReadFileRequest

AccessibleFolder folder = 1

string filename = 2

int64 start = 3

int64 len = 4

message ReadFileResponse

int64 readCount = 1

bytes data = 2

rpc FSGetFileInfo (FileInfoRequest, FileInfoResponse)

message FileInfoRequest

string path = 1

message FileInfoResponse

string name = 1

int64 size = 2

uint32 mode = 3

int64 modTime = 4

bool isDir = 5

rpc FSCreateTempDirOrFile (TempDirOrFileRequest, TempDirOrFileResponse)

message TempDirOrFileRequest

string dir = 1