Scanning provides configuration for low level radio options.

Scanning Configuration

`Scanning`

Scanning describes the configuration for Bluetooth Scanning

Fields

Name	Type	Description	Required
`bleFirmware`	string	Select BLE firmware version (bt5.0, bt5.0-mynewt) Will not override custom fw if programmed	No
`bleH4Socket`	object	H4 socket server configuration, if present will prevent pipelines from running.	No
`bleLayer`	BLELayer		No
`bleResetWithSWD`	boolean	Force BLE firmware reset strategy (SWD/Reset Pin) + true: reset via SWD interface + false: reset via reset pin	No
`devices`	array	Devices to scan on, only 1 device is currently supported	No
`disableBluetooth`	boolean	disable bluetooth?	No
`inputEventChannelDepth`	integer	Input event channel (for advertisements, remote antenna data, cloud msgs, etc)	No
`mdnsSettings`	Mdns		No
`remoteAntenna`	object	Configures remote antenna	No
`wirepas`	Wirepas		No

Reference

`BLELayer`

Advanced configuration for BLE layer

Referenced By:
Scanning

Fields

Name	Type	Description	Required
`connectionSlots`	ConnectionSlotsConfig		No
`lowEnergy`	LowEnergyOptions		No

`ConnectionSlotsConfig`

BLE Connection Slots Configuration

Referenced By:
BLELayer

Fields

Name	Type	Description	Required
`connectionSlots`	integer	Set the number of BLE connection slots The number of connection slots is the maximum number of concurrent BLE connections supported must be > 0	No
`retryDelay`	?	Retry delay when no connection slot is available must be a positive duration string	No
`retryTimeoutMultiplier`	integer	Timeout multiplier for waiting for a BLE connection slot to be available The connect filter timeout is multiplied by this value to determine the connection slot timeout value. must be > 0	No

`LowEnergyOptions`

Referenced By:
BLELayer

Fields

Name	Type	Description	Required
`notifBufferLength`	integer	size of the lowenergy notification buffer (per service/characteristic)	No
`notifSubTimeout`	?	timeout for adding a notification subscriber or sending a notification to a subscriber	No
`notifTimeout`	?	timeout for sending a notification from ble/bgapi device into the lowenergy buffer	No

`Mdns`

Advanced configuration for mdns behavior

Referenced By:
Scanning

Fields

Name	Type	Description	Required
`debug`	boolean	Enable debug logging	No
`debugInput`	object	Enable logging a custom map built from the input map; will override the default event logging Define the map as key pairs (see inject), supports dot-notation, templating Example: `{ "importantValue": "{{.nested.important.value}}"}`	No
`debugOutput`	object	Enable logging a custom map built from the output map; will override the default event logging Define the map as key pairs (see inject), supports dot-notation, templating Example: `{ "importantValue": "{{.nested.important.value}}"}`	No
`refreshInterval`	integer	Refresh Interval specified how often mdns requests should be sent	No
`verbose`	boolean	Enable verbose logging	No

`Wirepas`

Configuration for setting up to use the Wirepas Mesh. When participating
in a Wirepas mesh, Edge Connect is a sink.

Referenced By:
Scanning

Fields

Name	Type	Description	Required
`authKey`	string	Wirepas Authentication key This value is a hexadeimcal string	No
`cipherKey`	string	Wirepas cipher key This value is a hexadecimal string	No
`debug`	boolean	Enable debug logging	No
`debugInput`	object	Enable logging a custom map built from the input map; will override the default event logging Define the map as key pairs (see inject), supports dot-notation, templating Example: `{ "importantValue": "{{.nested.important.value}}"}`	No
`debugOutput`	object	Enable logging a custom map built from the output map; will override the default event logging Define the map as key pairs (see inject), supports dot-notation, templating Example: `{ "importantValue": "{{.nested.important.value}}"}`	No
`networkAddress`	integer	Wirepas network address. Network addresses are 24-bits. This value is an unsigned 32-bit number Valid network addresses are 1 - 16777214. Note that when the Wirepas stack converts this value to bytes, no byte in the address may be 0x55 or 0xAA.	Yes
`networkChannel`	integer	Wirepas network channel; network channel is a single byte value (1-255) This value is an unsigned 8-bit value	Yes
`sinkNodeAddress`	integer	Wirepas Sink Node Address on the Wirepas network; Wirepas node addresses are 32-bit values This value is an unsigned 32-bit number. Valid addresses are: + 1 - 2147483647 + 2164260864 - 4294967293 Example: `42`	Yes
`verbose`	boolean	Enable verbose logging	No
`version`	string	The version of Wirepas firmware to run on the radio. Currently supported versions are 5.2.0.53, 5.1.0.97, and 4.0.68.	Yes