iot transportProfile

iot transportProfile <profile>

accessID <accessID>

accessToken <token>

ageFilter

authentication-mode {client-credentials|none|password}

authentication URL

azure-dps-auth-type group-enrollment symmetric-key <key>

azure-dps-id-scope

bleDataForwarding

blePeriodicTelemetryDisable

cellSizeFilter

cipher-list

client-secret

clientID <id>

clone

companyIdentifierFilter <filter>

customFadingFactor

dataFilter <dataFilter>

deviceClassFilter {abilitySmartSensor|all|aruba-beacons|aruba-sensors|aruba-tags|assa-abloy|eddystone|enocean-sensors|enocean-switches|exposure-notification|google|ibeacon|minew|mysphera|sbeacon|serial-data|unclassified|wifi-assoc-sta|wifi-tags|wifi-unassoc-sta|wiliot|zf-tags|ZSD}

deviceCountOnly

environmentType {auditorium|custom|office|outdoor|shipboard|warehouse}

include-ap-group

localNameFilter <filter>

macOuiFilter <filter>

movementFilter <threshold>

no

password <password>

perFrameFiltering

proxy {server <servernm> port <portnum> |user <usernm> password <passwd>}

reportingInterval <interval>

rssiReporting

rtlsDestMac <rtlsDestMac>

serverType {Assa-Abloy | Azure-IoTHub | Meridian-Asset-Tracking | Meridian-Beacon-Management | Telemetry -Https | Telemetry-Websocket}

serverURL <url>

serviceUUIDFilter <filter>

uidNamespaceFilter

urlFilter

username <user>

uuidFilter <filter>

usbSerialDeviceTypeFilter <filter>

vendorFilter

ZSDFilter

Description

This command configures or modifies an IoT transport profile. An IoT transport profile is a global profile that is used to transport BLE information to an endpoint server.

In some cases, the iot transport profile having a serverType that is supported from AOS 8.4.0.0 version onwards will be skipped when downgrading to a previous version. In such cases, the default serverType will be applied. The default serverType applied might not be a valid serverType that corresponds with other parameters configured in the iot transport profile. The operator must manually fix the configuration parameters in the iot transport profile to match the serverType.

Parameter

Description

accessID <accessID>

An access ID will grant extended access. Applies only to endpoint type Assa-Abloy.

accessToken <accessToken>

Access token. Configure this only if you want to bypass authentication.

ageFilter

Age filter. Devices without recent activity will not be reported.

authentication-mode

Authentication mode to use with authentication server. Available options are:

  • client-credentials - Use credentials of the client
  • none - Do not use any credentials
  • password - Use password as credentials

authenticationURL <url>

Server URL for authentication.

azure-dps-auth-type group-enrollment symmetric-key <key>

Symmetric key to enroll devices in a group on the Azure DPS.

azure-dps-id-scope

Azure DPS ID scope for device provisioning.

bleDataForwarding

Enables BLE data forwarding for known devices.

blePeriodicTelemetryDisable

Disable periodic telemetry report.

NOTE: This command only works for telemetry-websocket Server Type.

cellSizeFilter

A proximity filter. Devices outside the cell will not be reported. Size is specified in meters. Setting to 0 disables the cell size filter.

cipher-list

Cipher list to be used for connections between IOT transport profile and third party server.

client-secret

Password to use when authenticating using client credentials.

clientId <id>

This ID identifies the sender to the server.

clone

Copy data from another IoT data profile.

companyIdentifierFilter <filter>

This is a 2-bytes integer, for example, "HPE - 0x011B" or "Wiliot - 0x0500. You can also include an extra byte which indicates the next layer type, like for HPE - 0x011B, 0x08, which means that the device type used is HPE Aruba Networking sensors.

customFadingFactor

When environment type is custom, you can define a fading factor to get the most accurate distance according to your environment.

Range: 10-40

dataFilter <dataFilter>

A list of numbers to filter the data before reporting to a server. The numbers correspond to protobuf files. For dataFilter values, see DataFilter Values.

deviceClassFilter <device>

A list of device class tags to filter the devices included in the reports. You can specify a maximum of 10 device classes.

abilitySmartSensor

ABB ability smart sensor data

all

All BLE data

aruba-beacons

Aruba beacon data

aruba-sensors

Aruba sensor data

aruba-tags

Aruba tag data

assa-abloy

Assa Abloy door lock data

eddystone

Eddystone data

enocean-sensors

EnOcean sensor data

enocean-switches

EnOcean switch data

exposure-notification

Exposure notification based on the presence of service UUID 0xFD6F and service data 0xFD6F

google

Google sensor data

ibeacon

iBeacon data

minew

Minew data

mysphera

MySphera data

sbeacon

Sbeacon data

serial-data

Serial data

unclassified

Unclassified data

wifi-assoc-sta

Data of WiFi associated stations

wifi-tags

WiFi RTLS tag data

wifi-unassoc-sta

Data of WiFi unassociated stations

wiliot

Wiliot data

zf-tags

ZF tag data

ZSD

ZigBee Socket Device

deviceCountOnly

Send only the aggregated device counts per configured device class

environmentType

Configure the working environment type.

auditorium

Configure the working environment type as auditorium.

custom

Configure a custom working environment type. Optionally, configure customFadingFactor.

office

Configure the working environment type as office.

outdoor

Configure outdoor working environment type.

shipboard

Configure the working environment type as shipboard.

warehouse

Configure the working environment type as warehouse.

include-ap-group

Configure AP groups that use the transport profile.

localNameFilter <filter>

It is a string, that can do string matching. It matches both advertisement and scan response.

macOuiFilter <filter>

It is a 3 bytes array. Only public MAC address(non-randomized) are considered. For example, 60:C0:BF is MAC OUI of Blyott devices.

movementFilter <threshold>

Filters devices that do not change distance. Specified in meters. Applicable only if a cell size is set. Setting to 0 disables the movement filter.

no

Removes any existing configuration.

password <password>

Password for authentication.

perFrameFiltering

Applies transport profile filters to each frame rather than on the device. This parameter can be enabled only when the parameter bleDataForwarding is enabled. This parameter is ignored when the parameter bleDataForwarding is disabled. This parameter is disabled by default.

proxy

Information of the proxy server to which the IoT data is sent.

server <servernm> port <portnum>

IP address and port number of the proxy server.

user <usernm> password <passwd>

Username and password to log in to the proxy server. This parameter is optional.

reportingInterval<interval>

Reporting interval in seconds.

Range: 5 to 3600 seconds

rssiReporting <format>

Set the preferred format for RSSI reporting.

average

RSSI averaged over the reporting period

bulk

RSSI Bulk

last

Most Recent RSSI

max

Maximum RSSI measured over the reporting period

smooth

Smoothed RSSI measured over the reporting period

rtlsDestMAC

Set the destination MAC address filter for RTLS tags.

serverType <type>

The type of server that is receiving the telemetry stream.

Assa-Abloy

Stream data to Assa Abloy Visionline server.

Azure-IoTHub

Stream data to Azure IoT hub.

Meridian-Asset-Tracking

Stream data to Meridian websocket server.

Meridian-Beacon-Management

POST data to a RESTful Meridian API.

Telemetry-Https

POST data to a RESTful Aruba API.

Telemetry-Websocket

Stream data to a websocket based server.

serverURL <url>

Server URL for sending telemetry.

serviceUUIDFilter <filter>

It is a 2 bytes integer, and it could be more than one entry. For example, 0x180F is SIG-adopted service UUID.

uidNamespaceFilter

A list of UID namespaces to filter devices included in the reports. Applies only Eddystone-UID devices. You can specify a maximum of 10 namespaces.

urlFilter

A list of URL strings to filter devices included in the reports. Applies only Eddystone-URL devices. The string listed here can be partial URL strings. You can specify a maximum of 10 URL strings.

username <user>

Username for authentication.

uuidFilter <filter>

A list of UUIDs to filter the devices included in the reports. Applies only to iBeacon devices. You can specify a maximum of 10 UUIDs.

usbSerialDeviceTypeFilter <filter>

Enables the use to filter serial data based on the USB serial dongle type. The following serial data type can be filtered:

  • EnOcean
  • OSU
  • Piera

vendorFilter

A list of list of vendor IDs and vendor names. You can specify a maximum of 5 vendor IDs or vendor names.

ZSDFilter

A list of ZSD to filter the zigbee socket devices.

DataFilter Values

Value

Description

#2

reporter

2.1

name

2.3

ipv4

2.4

ipv6

2.5

hwType

2.6

swVersion

2.7

swBuild

2.8

time

#3

reported

3.2

deviceClass

3.3

model

3.4

firmware

3.5

assetId

3.6

publicKey

3.7

lastSeen

3.9

bevent

3.10

rssi

3.11

cell

3.12

beacons

3.13

txpower

3.14

sensors

3.14.1

accelerometer

3.14.2

battery

3.14.3

temperatureC

3.14.4

humidity

3.14.5

voltage

3.14.6

illumination

3.14.7

motion

3.14.8

current

3.14.9

CO

3.14.10

CO2

3.14.11

VOC

3.14.12

resistance

3.14.13

pressure

3.14.14

alarm

3.14.15

contact

3.14.16

occupancy

3.14.17

mechanicalHandle

3.14.18

distance

3.14.19

capacitance

3.16

stats

3.16.1

uptime

3.16.2

adv_cnt

3.16.3

seq_nr

3.17

inputs

3.18

vendorData

3.19

vendorName

3.20

sensorTimestamp

3.21

flags

3.22

localName

3.23

identity

Example

The following example configures an IoT transport profile.

(host) [mynode] (config) #iot transportProfile sample

(host) [mynode] (IoT Data Profile "sample") #serverURL https://edit.meridianapps.com/api/beacons/manage

(host) [mynode] (IoT Transport Profile "sample") #serverType Meridian-Beacons-Management

(host) [mynode] (IoT Transport Profile "sample") #deviceClassFilter managed-beacons

(host) [mynode] (IoT Transport Profile "sample") #reportingInterval 300

(host) [mynode] (IoT Transport Profile "sample") #accessToken MzkxMTZlMWYtYTgzYS00YWUxLTkzYWEtYjQyNzE1MGMyMjAxOjBiZWJjYWViLTRjNjItNGEwNC1hMGIyLWYzZTM5ZDFlNGVkNg==

Related Commands

Command

Description

iot usetransportProfile

Sets an IoT management server profile.

show iot transportProfile

Shows the IoT profile status.

Command History

Release

Modification

AOS 8.9.0.0

The following parameters were introduced:

  • usbSerialDeviceTypeFilter <filter>
  • companyIdentifierFilter <filter>
  • serviceUUIDFilter <filter>
  • macOuiFilter <filter>
  • localNameFilter <filter>

The server-type ZF-Openmatics parameter was removed.

AOS 8.8.0.0

The following parameters were introduced:

  • azure-dps-auth-type group-enrollment symmetric-key
  • azure-dps-id-scope
  • authentication-mode
  • client-secret
  • bleDataForwarding
  • perFrameFiltering

The following deviceClassFilters were introduced:

  • google
  • minew

The Azure-IoTHub server type was introduced.

AOS 8.7.0.0

The following parameters were introduced:

  • ZSDFilter
  • dataFilter

The following deviceClassFilter were introduced:

  • exposure-notification
  • serial-data
  • wiliot
  • ZSD

The enableOnController parameter was removed.

AOS 8.6.0.0

The following parameters were introduced:

  • deviceCountOnly
  • proxy
  • rtlsDestMAC
  • vendorFilter

The following deviceClassFilters were introduced:

  • abilitySmartSensor
  • mysphera
  • sbeacon
  • wifi-assoc-sta
  • wifi-tags
  • wifi-unassoc-sta

AOS 8.5.0.0

Added the aruba-sensors sub-parameter to the deviceClassFilter parameter.

AOS 8.4.0.0

The following server types were introduced:

  • Meridian-beacons-management
  • Meridian-asset-tracking
  • Telemetry-https
  • Telemetry-websocket
  • ZF-openmatics

The following deviceClassFilters were introduced:

  • all
  • aruba-beacons
  • aruba-tags
  • eddystone
  • enocean-sensors
  • enocean-switches
  • ibeacon
  • unclassified
  • zf-tags

The following parameters were renamed from:

  • endpointType to serverType
  • endpointID to clientID
  • endpointURL to serverURL
  • endpointToken to accessToken
  • transportInterval to reportingInterval
  • payloadContent to deviceClassFilter
  • filterAttribute to uuidFilter
  • namespaceFilter to uidNamespaceFilter
  • cellSize to cellSizeFilter
  • thresholdAttribute to movementFilter
  • outrangeAgeout to ageFilter

AOS 8.3.0.0

Command introduced.

Command Information

Platforms

License

Command Mode

All platforms

Base operating system.

Configuration IoT Data Profile Mode (config-submode).