Breadcrumbs

Wireless Devices

The Wireless Devices command is sent to the datasource to manage the Bluetooth and Wi-Fi device databases for Sodera, X240, X500, X500e or X700. This command does not require capture hardware to be connected. The command format is:

“Wireless Devices;<action>;<action parameters>”

where valid actions are:

  • browse - returns a listing of wireless device addresses.

  • detail - returns known details for a given wireless device if it exists.

  • select - selects the wireless device for analysis and optionally adds device to favorites list if the device exists.

  • add - adds a wireless device to the database.

  • nickname - sets the nickname for a wireless device if it exists.

  • delete - deletes a wireless device from the database if it exists.

The “action” parameter must follow the command and precede the “action parameters”.

Action parameters are in the form of “key=value;key=value…;key=value”.

Action parameter keys must precede action parameter values.

Devices in the database will be referenced by “device address” in some command responses and some action parameters.

Device address format: “hh:hh:hh:hh:hh:hh”, where ‘h’ represents a hexadecimal digit from the set “0123456789abcdefABCDEF”.

For all commands, valid values for “type” are:

  • “bluetooth” –Bluetooth devices

  • “wifi” –Wi-Fi devices

For all commands, the response will be like “WIRELESS DEVICES;<status>” or “WIRELESS DEVICES;<status>;Reason=<reason>” - reason will be supplied for some SUCCEEDED and all FAILED status. The reason will vary for SUCCEEDED or FAILED and according to the action and/or failure.


Wireless Devices – Browse

The command format is:

“Wireless Devices;browse;type=<type>”,

where the type parameter is required.

Example – “Wireless Devices;browse;type=bluetooth”

For SUCCEEDED status, the reason will be dependent on the number of devices in the specified wireless device database: The automation command response buffer can carry a maximum of 112 addresses.

  • If there are 112 or fewer devices, reason will be like “WIRELESS DEVICES;SUCCEEDED;REASON=<semi-colon-delimited list of device addresses>”

  • If there are more than 112 devices, reason will be composed of multiple responses:

    • WIRELESS DEVICES;SUCCEEDED;REASON=DEVICE ADDRESSES WILL BE DELIVERED IN THE FOLLOWING <n> RESPONSES.” Where “n” is the integer number of blocks required to deliver all of the device addresses at 112 device addresses per block. For example, if there were 115 device addresses, n = 2 - one response would contain 112 device addresses and one response would contain 3 device addresses.

    • “n” responses of the form “WIRELESS DEVICES;SUCCEEDED;REASON=<semi-colon-delimited list of device addresses>”


Wireless Devices – Detail

The command format is:

“Wireless Devices;detail;address=<device address>;type=<type>”

where the address and type parameters are required.

Example – Wireless Devices;detail;address=11:fe:ed:b0:b0:11;type=wifi

For SUCCEEDED status, the reason will be like “WIRELESS DEVICES;SUCCEEDED;REASON=DEVICETYPE=WIFI|ADDRESS=<device address>|FAVORITE=NO|ACTIVE=YES|RSSI=-27DBM|PACKETS=3034|NICKNAME="<nickname>"|COMPANYID="<company name>"|CURRENTSESSION=NO|VERSION="<WI-FI version>"|SECURITY=""|BSSID=NO|SSID=""|CHECKED=YES|”


Wireless Devices – Select

The command format is:

“Wireless Devices;select;type=<type>;address=<device address/all>;select=<yes/no>;favorite=<yes/no>”

where the address and type parameters are required and at least one other parameter is required.

Example:

Wireless Devices;select;address=11:fe:ed:b0:b0:11;type=bluetooth;select=yes;favorite=yes


Wireless Devices - Add

The command format is:

“Wireless Devices;add;address=<device address>;type=<type>;lerandom=<yes/no>;irk=<device IRK>;select=<yes/no>;favorite=<yes/no>”

where the address and type parameters are required. If the favorite parameter is omitted for a new device, that device will be put on the favorite list by default. This command is not valid for open files.

The parameter “lerandom” is optional unless a valid device IRK is specified – then it must be present with a value of “yes”

The parameter “irk” is optional. A valid value is of the form

“0xhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh”

where ‘h’ represents a hexadecimal digit from the set “0123456789abcdefABCDEF”. If this parameter is specified but “lerandom” is not specified, or “lerandom” is specified as something other than “yes”, the command will be rejected as invalid.

Examples:

Wireless Devices;add;address=11:fe:ed:b0:b0:11;type=wifi

Wireless Devices;add;address=0x60b468dabd3c;type=bluetooth;lerandom=yes; irk=c48290c8466d380d467dd0d53ab11409


Wireless Devices – Nickname

The command format is:

“Wireless Devices;nickname;address=<device address>;type=<type>;nickname=”<nickname>”

where the address and type parameters are required and the nickname parameter with the nickname value in quotes is required.

Example – Wireless Devices;nickname;address=11:fe:ed:b0:b0:11;type=wifi;nickname=”Outdoor Lights”


Wireless Devices - Delete

The command format is:

“Wireless Devices;delete;address=<device address>;type=<type>”

where the address and type parameters are required. This command is not valid for open files.

Example – Wireless Devices;delete;address=11:fe:ed:b0:b0:11;type=wifi”