- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
01-IoT gateway commands | 152.99 KB |
Contents
display iot mmgr running-configuration
display iot module firmware-upgrade history
display iot module information
iot auto-module persistent all
iot auto-module persistent enable
iot execute module firmware-upgrade
iot execute module restore-factory
module firmware-upgrade disable
rfid-tracking ble advertisement
rfid-tracking ble advertisement enable
rfid-tracking ble advertisement interval
rfid-tracking ble report enable
rfid-tracking ble report interval
rfid-tracking ble vendor-ibeacon report enable
rfid-tracking iot rssi threshold
rfid-tracking iot sampling enable
rfid-tracking iot sampling interval
rfid-tracking keepalive enable
IoT gateway commands
The following compatibility matrixes show the support of hardware platforms for IoT gateway.
Hardware series |
Model |
IoT gateway compatibility |
WA6600 series |
WA6628E-T |
No |
WA5600 series |
WA5630X WA5620E-T |
Yes: WA5630X No: WA5620E-T |
WA5500 series |
WA5530 WA5530i WA5530X WA5530S WA5530-SI WA5530-LI WX2540H-F WA5510E-T |
Yes: · WA5530i · WA5530X · WA5530-SI · WA5530-LI No: · WA5530 · WA5530S · WA5510E-T |
WA5300 series |
WA5320i WA5320i-LI WA5320X WA5320X-LI WA5320X-E WA5320X-SI WA5340 |
Yes: · WA5320i · WA5320i-LI · WA5320X · WA5320X-LI · WA5320X-SI · WA5340 No: WA5320X-E |
UAP300 series |
UAP300 |
Yes |
WAP723 series |
WAP723-W2 |
Yes |
WAP722 series |
WAP722X-W2 WAP722XS-W2 |
Yes |
Hardware series |
Model |
IoT gateway compatibility |
WA530 series |
WA538 WA536 WA5330 WA530X |
No: · WA538 · WA536 · WA530X Yes: WA5330 |
description (module view)
Use description to configure a description for a module.
Use undo description to restore the default.
Syntax
description text
undo description
Default
A module does not have a description.
Views
Module view
Predefined user roles
network-admin
Parameters
text: Specifies a description, a case-sensitive string of 1 to 64 characters.
Usage guidelines
According to the module models, locations, and functions, configure descriptions for the modules.
Examples
# Configure a description for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] description L3-office
display iot mmgr running-configuration
Use display iot mmgr running-configuration to display running configuration information about the Internet of Things (IoT) module manager.
Syntax
display iot mmgr running-configuration
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display running configuration information about the IoT module manager.
<Sysname> display iot mmgr running-configuration
IOT status : Enabled
Auto-module : Disabled
Auto-module persistent : Disabled
Keepalive status : Enabled
Sampling interval : 10 seconds
T300-R server domain-name : N/A
T300-R domain IP : N/A
T300-R server address : N/A
T300-R server port : N/A
T300-B server domain-name : N/A
T300-B domain IP : N/A
T300-B server address : N/A
T300-B server port : N/A
EW100-R server address : N/A
EW100-R server port : N/A
T100-A server address : N/A
T100-A server port : N/A
T100-TP server address : N/A
T100-TP server port : N/A
T300BP0R server address : N/A
T300BP0R server port : N/A
T300PB0U server address : N/A
T300PB0U server port : N/A
T300RT0R server address : N/A
T300RT0R server port : N/A
BLE report : Disabled
BLE vendor-ibeacon report : Disabled
BLE report interval : 900 seconds
BLE aging time : 180 seconds
Location module inside : N/A
Location module outside : N/A
Location rssi period : 6
Location valid-rssi : 70
Location diff-rssi : 5
Module 1:
Module type : RFID
Module status : Disable
Firmware upgrade status : Enable
Description : N/A
Tx-power : 1
Led-mode : Normal
Module report-mode : Parse
Packet length-field : 8
Packet format : h3c
Rssi threshold : 126
Sample status : Disable
Advertisement status : Disable
Advertisement UUID : E1CC5B618C06428E8720FE619DB80193
Advertisement majorID : 1
Advertisement minorID : 1
Advertisement measured-power : 58
Advertisement interval : 100
Table 1 Command output
Field |
Description |
IOT status |
IoT module scanning: · Enabled. · Disabled. |
Auto-module |
Auto module feature: · Enabled. · Disabled. |
Auto-module persistent |
Auto module conversion: · Enabled. · Disabled. |
Keepalive status |
Keepalive feature: · Enabled. · Disabled. |
Sampling interval |
Location packet sampling interval, in seconds. |
Module-type server domain-name |
Domain name of the IoT server. The Module-type field specifies a type of module. |
Module-type server domain IP |
IP address of the IoT server resolved from the domain name. The Module-type field specifies a type of module. |
Module-type server address |
IP address of the IoT server. The Module-type field specifies a type of module. |
Module-type server port |
Port number of the IoT server. The Module-type field specifies a type of module. |
BLE report |
BLE neighbor list reporting: · Enabled. · Disabled. |
BLE vendor-ibeacon report |
Reporting of BLE neighbors sending non-standard advertisements to the server: · Enabled. · Disabled. |
BLE report interval |
Interval for sending neighbor list reports, in seconds. |
BLE aging time |
Aging time for iBeacon devices, in seconds. |
Location module inside |
IDs of the inside-campus IoT modules. |
Location module outside |
IDs of the outside-campus IoT modules. |
Location rssi period |
Average RSSI calculation period. |
Location valid-rssi |
Valid average RSSI threshold. |
Location diff-rssi |
Difference RSSI threshold. |
Module Module-id |
IoT module ID. |
Module type |
Type of the IoT module. |
Module status |
IoT module status: · Enabled. · Disabled. |
Firmware upgrade status |
Automatic firmware upgrade for the IoT module: · Enabled. · Disabled. |
Description |
Description for the IoT module. |
Tx-power |
Transmit power level for the IoT module. |
Led-mode |
LED lighting mode for the IoT module: · Normal. · Quiet. |
Module report-mode |
Report mode for packets sent to IoT gateway: · Parse. · Transparent. |
Packet length-field |
Value for the length field of IoT packets. |
Packet format |
Format for IoT packets received by the IoT module. |
Rssi threshold |
RSSI threshold for location packets. |
Sample status |
Location packets sampling of the IoT module: · Enabled. · Disabled. |
Advertisement status |
Transmission of iBeacon advertisement information: · Enabled. · Disabled. |
Advertisement UUID |
UUID in the iBeacon advertisements. |
Advertisement majorID |
Major ID in the iBeacon advertisements. |
Advertisement minorID |
Minor ID in the iBeacon advertisements. |
Advertisement measured-power |
Measured power in the iBeacon advertisements. |
Advertisement interval |
Interval for sending iBeacon advertisements, in milliseconds. |
display iot module all
Use display iot module all to display information about all IoT gateways that have IoT interfaces and the connected modules.
Syntax
display iot module all
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display information about all IoT gateways that have IoT interfaces and the connected modules.
<System> display iot module all
Modules : 6
State : manual, auto(*)
Port ID: 3
----------------------------------------------------------------------------
ModuleID Model SerialNumber H/WVer S/WVer LastRebootReason
1 T300M-X 219801A19A8171E00016 Ver.A E1102 Other
3 T300-X 219801A19A8171E00017 Ver.A E1102 Power On
4* T300-X 219801A19A8171E00018 Ver.A E1102 Other
Port ID: 4
----------------------------------------------------------------------------
ModuleID Model SerialNumber H/WVer S/WVer LastRebootReason
----------------------------------------------------------------------------
10* T300M-X 219801A19A8171E00019 Ver.A E1102 Other
11 T300-X 219801A19A8171E00020 Ver.A E1102 Other
12* T300-X 219801A19A8171E00021 Ver.A E1102 Power On
Table 2 Command output
Field |
Description |
Modules |
Number of modules that are connected to the IoT AP. |
Port ID |
ID of the port that connects the module to the IoT AP. If the IoT module connects to the IoT AP automatically, this field displays *. |
ModuleID |
ID of the module. |
Model |
Module model. |
SerialNumber |
Serial number of the module. |
H/WVer |
Hardware version of the module. |
S/WVer |
Software version of the module. |
LastRebootReason |
Last reboot reason for the module: · Power On—Power cycle. · SOFTRESET—Soft reboot. · WDG—Watchdog reboot. · CAN_TASK_FAIL—Failed to create a CAN task. · UART_TASK_FAIL—Failed to create a UART task. · DEV_TASK_FAIL—Failed to create a DEV task. · EMAC_TASK_FAIL—Failed to create an EMAC task. · RIPC—RIPC connection timer timed out. · RATE—Self adjustment of CAN rate failed. · SCHEDULER—Task scheduling failed. · BUTT—Reserved. · HARDFAULT—CPU hardware fault. · MPUFAULT—CPU storage management fault. · BUSFAULT—CPU bus fault. · USAGEFAULT—CPU use fault. · Other—Reserved. |
display iot module firmware-upgrade history
Use display iot module firmware-upgrade history to display firmware upgrade information for modules.
Syntax
display iot module firmware-upgrade history { all | module module-id }
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
all: Specifies all modules.
module-id: Specifies a module by its ID.
Usage guidelines
This command displays history records about manual firmware upgrade for a module on an IoT gateway from the time that the IoT gateway starts. To display the module firmware version after manual or automatic upgrade, use the display iot module information command.
Examples
# Display firmware upgrade information for all modules.
<Sysname> display iot module firmware-upgrade history all
Module ID Last upgraded time Upgrade status SW version
1 Mon Nov 2 13:54:23 2018 Succeeded 12-09-02-22
Table 3 Command output
Field |
Description |
Module ID |
ID of the IoT module. |
Last upgraded time |
Time for the most recent firmware upgrade. |
Upgrade status |
Upgrade status: · Succeeded. · Failed. · Upgrading. This field displays N/A if the module has not been updated. |
SW version |
Module software version. |
Related commands
display iot module information
display iot module information
Use display iot module information to display module information.
Syntax
display iot module information { all | module module-id }
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
all: Specifies all modules.
module module-id: Specifies a module by its ID.
Examples
# Display information about module 1.
<Sysname> display iot module information module 1
Module type : RFID
Module vendor : H3C
Model : T300-R
HW version : Ver.A
SW version : R1225TS V100R001B01D029SP25TS
Serial ID : 219801A1FN8187E0006T
Module MAC : 90e7-1022-76b2
Module physical status : Normal
Module administrative status : Enabled
Description : Not configured
Table 4 Command output
Field |
Description |
Module type |
Module type: · NotConfig. · RFID. · BLE. |
Module vendor |
Physical type of the module: · H3C. · Third-party. This field displays N/A if no physical type information is available. |
Model |
Module model. This field displays N/A if no module model information is available. |
HW version |
Module hardware version. |
SW version |
Module software version. |
Serial ID |
Module serial ID. |
Module MAC |
MAC address of the module. |
Module physical status |
Physical status of the module: · Unavailable. · Unusable. · Normal. · Absent. |
Module administrative status |
Configured module status: · Enabled. · Disabled. |
Description |
Description about the IoT module. This field displays Not configured if no description is configured. |
iot auto-module enable
Use iot auto-module enable to enable the auto module feature.
Use undo iot auto-module enable to disable the auto module feature.
Syntax
iot auto-module enable
undo iot auto-module enable
Default
The auto module feature is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
This command enables a module to associate with an IoT gateway without manual module configuration.
This command takes effect only when IoT modules connect to the IoT gateway through network cables.
Examples
# Enable the auto module feature.
<Sysname> system-view
[Sysname] iot auto-module enable
Related commands
display iot module information
iot auto-module persistent all
Use iot auto-module persistent all to convert all online auto modules to manual modules.
Syntax
iot auto-module persistent all
Views
System view
Predefined user roles
network-admin
Usage guidelines
This command converts all online auto modules to manual modules and automatically assigns a serial number to each converted module.
This command takes effect only when IoT modules connect to the IoT gateway through network cables.
Examples
# Convert all online auto modules to manual modules.
<Sysname> system-view
[Sysname] iot auto-module persistent all
Related commands
display iot module information
serial-number
iot auto-module persistent enable
Use iot auto-module persistent enable to enable auto module conversion.
Use undo iot auto-module persistent enable to disable auto module conversion.
Syntax
iot auto-module persistent enable
undo iot auto-module persistent enable
Default
Auto module conversion is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
The auto module conversion feature converts auto modules to manual modules automatically after auto modules come online. It takes effect only on auto modules that come online after you enable this feature. After the conversion, the system will also automatically assign a serial number to each converted module.
This command takes effect only when IoT modules connect to the IoT gateway through network cables.
Examples
# Enable auto module conversion.
<Sysname> system-view
[Sysname] iot auto-module persistent enable
iot execute module firmware-upgrade
Use iot execute module firmware-upgrade to upgrade the firmware for a module manually.
Syntax
iot execute module firmware-upgrade module module-id firmware-path filepath
Views
System view
Predefined user roles
network-admin
Parameters
module module-id: Specifies a module by its ID.
firmware-path filepath: Specifies the path for storing IoT module firmware file.
Usage guidelines
With auto firmware upgrade enabled, the IoT gateway will upgrade the firmware version automatically when the IoT gateway restarts if the firmware version upgraded automatically is different from that upgraded manually.
Examples
# Obtain the firmware version from the flash:/a.ipe path and upgrade the firmware version for module 1.
<Sysname> system-view
[Sysname] iot execute module firmware-upgrade module 1 firmware-path flash:/a.ipe
Related commands
display iot module firmware-upgrade history
iot execute module led-flash
Use iot execute module led-flash to trigger the LEDs on a module to flash regularly.
Syntax
iot execute module led-flash module module-id
Views
System view
Predefined user roles
network-admin
Parameters
module module-id: Specifies a module ID. The value range varies by AP model.
Usage guidelines
To locate a module connected to an IoT gateway, execute this command to trigger all LEDs on the module to flash 20 seconds at a rate of one flash per second.
Examples
# Trigger the LEDs of module 1 to flash regularly.
<Sysname> system-view
[Sysname] iot execute module led-flash module 1
iot execute module reset
Use iot execute module reset to restart a module.
Syntax
iot execute module reset module module-id
Views
System view
Predefined user roles
network-admin
Parameters
module module-id: Specifies a module by its ID.
Examples
# Restart module 1.
<Sysname> system-view
[Sysname] iot execute module reset module 1
iot execute module restore-factory
Use iot execute module restore-factory to restore the factory settings for a module on an AP.
Syntax
iot execute module restore-factory module module-id
Views
System view
Predefined user roles
network-admin
Parameters
module module-id: Specifies a module by its ID. The value range varies by AP model.
Usage guidelines
Use this command to clear the settings of a module and restore the factory settings for the module.
This command restarts a module and restores the factory settings of the module immediately.
Examples
# Restore the factory settings for module 1.
<Sysname> system-view
[Sysname] iot execute module restore-factory module 1
iot location module
Use iot location module to specify inside-campus IoT modules and outside-campus IoT modules.
Use undo iot location module to restore the default.
Syntax
iot location module module-id-list1&<1-6> inside module-id-list2&<1-6> outside
undo iot location module
Default
No inside-campus or outside-campus IoT modules are specified.
Views
System view
Predefined user roles
network-admin
Parameters
module-id-list1&<1-6>: Specifies a maximum of six modules by module ID. The value range for a module ID varies by device model.
inside: Configures modules specified by the module-id-list1&<1-6> argument as inside-campus IoT modules.
module-id-list2&<1-6>: Specifies a maximum of six modules by module ID. The value range for a module ID varies by device model.
outside: Configures modules specified by the module-id-list2&<1-6> argument as outside-campus IoT modules.
Usage guidelines
To enable an IoT AP to detect whether an IoT end node is inside or outside the campus, perform the following tasks:
· Enable IoT location on the IoT AP.
· Specify inside-campus IoT modules and outside-campus IoT modules for the IoT AP.
Examples
# Configure IoT modules 1, 2, and 3 as inside-campus modules and IoT modules 4 and 5 as outside-campus modules.
<Sysname> system-view
[Sysname] iot location module 1 2 3 inside 4 5 outside
Related commands
iot location rssi
rfid-tracking iot
iot location rssi
Use iot location rssi to set RSSI parameters for location packet filtering.
Use undo iot location rssi to restore the default.
Syntax
iot location rssi period period valid-rssi value diff-rssi value
undo iot location rssi
Default
The average RSSI calculation period is 6 seconds, the valid average RSSI threshold is 70, and the difference threshold is 5.
Views
System view
Predefined user roles
network-admin
Parameters
period period: Specifies the average RSSI calculation period in the range of 2 to 30 seconds.
valid-rssi value: Specifies the valid average RSSI threshold in the range of 1 to 100. A smaller value indicates a higher signal strength.
diff-rssi value: Specifies the difference threshold in the range of 1 to 100. The difference threshold refers to the threshold for the difference between the inside and outside average RSSIs.
Usage guidelines
The device determines whether a bracelet is inside or outside the campus based on the RSSI changes. An IoT module sends a location packet every second. Within an average RSSI calculation period, the IoT gateway calculates the inside and outside average RSSIs. If the calculated difference exceeds the configured difference threshold, the IoT module determines that the obtained data as valid, generates inside-campus and outside-campus information, and sends the information to the Oasis platform.
Examples
# Set the average RSSI calculation period to 8 seconds, the valid average RSSI threshold to 75, and the difference threshold to 3.
<Sysname> system-view
[Sysname] iot location rssi period 8 valid-rssi 75 diff-rssi 3
Related commands
iot location module
iot module
Use iot module to enter module view.
Syntax
iot module module-id
Views
System view
Predefined user roles
network-admin
Parameters
module-id: Specifies a module by its ID.
Usage guidelines
To configure and manage a module on an IoT gateway, you must first enter module view of the IoT gateway.
Examples
# Enter module view.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1]
iot module led-mode
Use iot module led-mode to specify a LED lighting mode for a module.
Use undo iot module led-mode to restore the default.
Syntax
iot module led-mode { normal | quiet }
undo iot module led-mode
Default
All LEDs of a module are in normal lighting mode.
Views
Module view
Predefined user roles
network-admin
Parameters
normal: Specifies the normal mode. In this mode, the LEDs flash regularly.
quiet: Specifies the quiet mode. In this mode, all LEDs are off.
Usage guidelines
If you do not want the LEDs to flash, set the LED flashing mode of the module to quiet.
Examples
# Specify the normal LED lighting mode for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] iot module led-mode normal
iot module report-mode
Use iot module report-mode to specify the report mode for packets sent to IoT gateways.
Use undo iot module report-mode to restore the default.
Syntax
iot module report-mode { parse | transparent }
undo iot module report-mode
Default
A module uses parse mode to send packets to the connected IoT gateway.
Views
Module view
Predefined user roles
network-admin
Parameters
parse: Specifies parse mode.
transparent: Specifies transparent mode.
Usage guidelines
A module can use the following modes to send packets to the connected IoT AP:
· Parse mode—Parses and examines received packets before sending them to the IoT AP.
· Transparent mode—Directly sends received packets to the IoT AP without any extra operations.
Configure modules to use transparent mode if modules are not allowed to parse received packets.
This command takes effect only on IoT APs without module slots.
Examples
# Configure module 1 to send packets to IoT AP by using parse mode.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] iot module report-mode transparent
iot module-type
Use iot module-type to specify an IoT server by the combination of the IP address or domain name and the port number.
Use undo iot module-type to restore the default.
Syntax
iot module-type { t300-b | t300-r } { server-address { ip | ipv6 } server-address | server-domain domain-name { ip | ipv6 } } port port
undo iot module-type { t300-b | t300-r } { server-address | server-domain }
iot module-type { ew100-r | t100-a | t100-tp | t300bp0r | t300pb0u | t300rt0r } server-address ip server-address port port
undo iot module-type { ew100-r | t100-a | t100-tp | t300bp0r | t300pb0u | t300rt0r } server-address
Default
No IoT server is specified.
Views
System view
Predefined user roles
network-admin
Parameters
t300-b: Specifies the T300-B type.
t300-r: Specifies the T300-R type.
ew100-r: Specifies the EW100-R type.
t100-a: Specifies the T100-A type.
t100-tp: Specifies the T100-TP type.
t300bp0r: Specifies the T300-BP0R type.
t300pb0u: Specifies the T300-BP0U type.
t300rt0r: Specifies the T300-RTOR type.
ip: Specifies the IPv4 address of the IoT server or the IPv4 address resolved by the domain name of the IoT server.
ipv6: Specifies the IPv6 address of the IoT server or the IPv6 address resolved by the domain name of the IoT server.
server-address: Specifies the IPv4 or IPv6 address of the IoT server.
domain-name: Specifies the domain name of the IoT server, a case-sensitive string of 1 to 253 characters.
port port: Specifies the port number of the IoT server in the range of 1 to 65535.
Usage guidelines
With the IP address and domain name of the IoT server configured, the specified IoT module connected to the IoT gateway can interact with the IoT server.
Examples
# Specify 192.168.10.10 and 3000 as the IPv4 address and port number of the IoT server and specify T300-R as the IoT module type.
<Sysname> system-view
[Sysname] iot module-type t300-r server-address ip 192.168.10.10 port 3000
# Specify 2001::5 and 3000 as the IPv6 address and port number of the IoT server and specify T300-R as the IoT module type.
<Sysname> system-view
[Sysname] iot module-type t300-r server-address ipv6 2001::5 port 3000
# Specify aaa as the domain name that can be resolved into IPv4 address of the IoT server, 3000 as port number of the IoT server, T300-R as the IoT module type.
<Sysname> system-view
[Sysname] iot module-type t300-r server-domain aaa ip port 3000
iot packet length-field
Use iot packet length-field to set the value for the length field of IoT packets.
Use undo iot packet length-field to restore the default.
Syntax
iot packet length-field { 8 | 6 }
undo iot packet length-field
Default
The value for the length field of IoT packets is 8 bits.
Views
Module view
Predefined user roles
network-admin
Parameters
8: Sets the value for the length field of IoT packets to 8 bits.
6: Sets the value for the length field of IoT packets to 6 bits.
Usage guidelines
Set the value for the length field of IoT packets based on the end node type. The value for the length field of IoT packets is 6 bits for HIK end nodes and 8 bits for bracelets.
Only RFID modules support this command.
Examples
# Set the value for the length field of IoT packets to 6 bits for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] iot packet length-field 6
module enable
Use module enable to enable a module.
Use undo module enable to restore the default.
Syntax
module enable
undo module enable
Default
A module is disabled.
Views
Module view
Predefined user roles
network-admin
Examples
# Enable module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] module enable
module firmware-upgrade disable
Use module firmware-upgrade disable to disable automatic firmware upgrade for a module.
Use undo firmware-upgrade disable to restore the default.
Syntax
module firmware-upgrade disable
undo module firmware-upgrade disable
Default
Automatic firmware upgrade is enabled for a module.
Views
Module view
Predefined user roles
network-admin
Usage guidelines
This feature enables a module to immediately upgrade its firmware if its firmware version is different from the version stored in the image file of the IoT gateway.
After you enable this feature for a module, this feature takes effect every time the IoT gateway where the module is installed restarts.
Examples
# Disable automatic firmware upgrade for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] module firmware-upgrade disable
Related commands
display iot module information
display iot module firmware-upgrade history
rfid-tracking ble advertisement
Use rfid-tracking ble advertisement to configure the advertisement information for a BLE module.
Use undo rfid-tracking ble advertisement to restore the default.
Syntax
rfid-tracking ble advertisement { major-id major-id | measured-power measured-power | minor-id minor-id | uuid uuid }
undo rfid-tracking ble advertisement { major-id | measured-power | minor-id | uuid }
Default
The Major ID is 1, Minor ID is 1, measured power is –58 dBm, and UUID is E1CC5B618C06428E8720FE619DB80193 in the advertisement information for a BLE module.
Views
Module view
Predefined user roles
network-admin
Parameters
major-id major-id: Specifies the Major ID in the advertisement information for a BLE module. The value range for the major-id argument is 0 to 65535.
measured-power measured-power: Specifies the measured power in the advertisement information for a BLE module. The value range for the measured-power argument is 0 to 127, which represents signal strength of –127 to 0 dBm. A larger value represents weaker signal strength. The measured power is the signal strength detected by the advertisement receiving device when the device is 1 m (3.28 ft) from the iBeacon device. The measured power can be used to calculate the distance between the advertisement receiving device and the iBeacon device.
minor-id minor-id: Specifies the Minor ID in the advertisement information for a BLE module. The value range for the minor-id argument is 0 to 65535.
uuid uuid: Specifies the UUID in the advertisement information for a BLE module. The value range for the uuid argument is a case-insensitive string of 32 hexadecimal digits from 0 to f.
Usage guidelines
A BLE module broadcasts iBeacon advertisements containing Major ID, Minor ID, measured power, and UUID to nearby application software. Application software that receives the advertisement information will take specific actions according to the advertisement information to fulfill their software functions.
Examples
# Configure the advertisement information for BLE module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] rfid-tracking ble advertisement major-id 4
[Sysname-iot-module-1] rfid-tracking ble advertisement minor-id 4
[Sysname-iot-module-1] rfid-tracking ble advertisement uuid 34ae56115098ca67321a11256bca3007
[Sysname-iot-module-1] rfid-tracking ble advertisement measured-power 100
rfid-tracking ble advertisement enable
Use rfid-tracking ble advertisement enable to enable the iBeacon transmission feature for a BLE module.
Use undo rfid-tracking ble advertisement enable to disable the iBeacon transmission feature for a BLE module.
Syntax
rfid-tracking ble advertisement enable
undo rfid-tracking ble advertisement enable
Default
The iBeacon transmission feature is disabled for a BLE module.
Views
Module view
Predefined user roles
network-admin
Usage guidelines
This command enables a BLE module to periodically broadcast iBeacon advertisements. An iBeacon advertisement contains a UUID, a Major ID, the measured power, and a Minor ID.
This command takes effect only for BLE modules when BLE location is enabled.
Examples
# Enable the iBeacon transmission feature for BLE module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] rfid-tracking ble advertisement enable
rfid-tracking ble advertisement interval
Use rfid-tracking ble advertisement interval to set the interval for a BLE module to broadcast iBeacon advertisements.
Use undo rfid-tracking ble advertisement interval to restore the default.
Syntax
rfid-tracking ble advertisement interval interval
undo rfid-tracking ble advertisement interval
Default
A BLE module broadcasts iBeacon advertisements every 100 centiseconds (1 second).
Views
Module view
Predefined user roles
network-admin
Parameters
interval: Specifies the interval for a BLE module to broadcast iBeacon advertisements with a step size of 10. The value range is 50 to 1000 centiseconds.
Examples
# Configure BLE module 1 to broadcast iBeacon advertisements every 200 centiseconds.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] rfid-tracking ble advertisement interval 200
rfid-tracking ble aging-time
Use rfid-tracking ble aging-time to set the aging time for iBeacon devices.
Use undo rfid-tracking ble aging-time to restore the default.
Syntax
rfid-tracking ble aging-time time
undo rfid-tracking ble aging-time
Default
The aging time for iBeacon devices is 180 seconds.
Views
System view
Predefined user roles
network-admin
Usage guidelines
Configure this command to help an IoT gateway discover iBeacon devices that are powered off or moved.
If the IoT gateway does not receive any packets from an iBeacon device within the aging time, the AP performs the following actions:
· Removes the device from the neighbor list.
· Notifies the IoT server of the device removal event.
Parameters
time: Specifies the aging time for iBeacon devices, in the range of 60 to 3600 seconds.
Examples
# Set the aging time for iBeacon devices to 60 seconds.
<Sysname> system-view
[Sysname] rfid-tracking ble aging-time 60
rfid-tracking ble report enable
Use rfid-tracking ble report enable to enable neighbor list reporting.
Use undo rfid-tracking ble report enable to disable neighbor list reporting.
Syntax
rfid-tracking ble report enable
undo rfid-tracking ble report enable
Default
Neighbor list reporting is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
Configure this command to enable IoT gateways to send neighbor list reports to the IoT server at the specified interval. The neighbor list contains the UUID, major ID, minor ID, and the most recently collected transmit power and RSSI of iBeacon devices.
Examples
# Enable neighbor list reporting.
<Sysname> system-view
[Sysname] rfid-tracking ble report enable
rfid-tracking ble report interval
Use rfid-tracking ble report interval to set the interval for sending neighbor list reports.
Use undo rfid-tracking ble report interval to restore the default.
Syntax
rfid-tracking ble report interval interval
undo rfid-tracking ble report interval
Default
The interval for sending neighbor list reports is 900 seconds.
Views
System view
Predefined user roles
network-admin
Parameters
interval: Specifies the interval for sending neighbor list reports, in the range of 1 to 86400 seconds.
Usage guidelines
As a best practice, set the interval to a minimum of 15 seconds. A short interval increases the workload of the IoT server.
Examples
# Set the interval for sending neighbor list reports to 5 seconds.
<Sysname> system-view
[Sysname] rfid-tracking ble report interval 5
rfid-tracking ble vendor-ibeacon report enable
Use rfid-tracking ble vendor-ibeacon report enable to enable the reporting of iBeacon devices sending non-standard advertisements to the IoT server.
Use undo rfid-tracking ble vendor-ibeacon report enable to disable the reporting of iBeacon devices sending non-standard advertisements to the IoT server.
Syntax
rfid-tracking ble vendor-ibeacon report enable
undo rfid-tracking ble vendor-ibeacon report enable
Default
The reporting of iBeacon devices sending non-standard advertisements to the IoT server is disabled.
Views
System view
Predefined user roles
network-admin
Examples
# Enable the reporting of iBeacon devices sending non-standard advertisements to the IoT server.
<Sysname> system-view
[Sysname] rfid-tracking ble vendor-ibeacon report enable
rfid-tracking iot enable
Use rfid-tracking iot enable to enable IoT location.
Use undo rfid-tracking iot enable to restore the default.
Syntax
rfid-tracking iot enable
undo rfid-tracking iot enable
Default
IoT location is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
Before configure RFID or BLE location, you must enable IoT location.
This command enables an IoT gateway to identify all packets from IoT end nodes through the IoT modules and forward the packets to the IoT server. The IoT server processes the reported packets.
Examples
# Enable IoT location.
<Sysname> system-view
[Sysname] rfid-tracking iot enable
rfid-tracking iot rssi threshold
Use rfid-tracking iot rssi threshold to set an RSSI threshold to filter location packets in IoT location.
Use undo rfid-tracking iot rssi threshold to restore the default.
Syntax
rfid-tracking iot rssi threshold rssi-threshold
undo rfid-tracking iot rssi threshold
Default
No RSSI threshold is set to filter location packets in IoT location.
Views
Module view
Predefined user roles
network-admin
Parameters
rssi-threshold: Specifies an RSSI threshold in the range of –127 to +125.
Examples
# Configure IoT module 1 to ignore location packets with an RSSI lower than 30.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] rfid-tracking iot rssi threshold 30
rfid-tracking iot sampling enable
Use rfid-tracking iot sampling enable to enable an IoT gateway to sample location packets from an IoT module.
Use undo rfid-tracking iot sampling enable to disable an IoT gateway from sampling location packets from an IoT module.
Syntax
rfid-tracking iot sampling enable
undo rfid-tracking iot sampling enable
Default
Location packet sampling is disabled.
Views
Module view
Predefined user roles
network-admin
Usage guidelines
Configure this command to prevent location packets sent by IoT end nodes whose location does not change or changes very little within a long period from affecting the overall performance of the IoT gateway. With this command configured, an IoT module sends only the sampled packets to the IoT gateway within each sampling interval.
Examples
# Enable location packet sampling.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] rfid-tracking iot sampling enable
Related commands
rfid-tracking iot sampling interval
rfid-tracking iot sampling interval
Use rfid-tracking iot sampling interval to set a location packet sampling interval.
Use undo rfid-tracking iot sampling interval to restore the default.
Syntax
rfid-tracking iot sampling interval interval
undo rfid-tracking iot sampling interval
Default
The location packet sampling interval is 10 seconds.
Views
System view
Predefined user roles
network-admin
Parameters
interval: Specifies the location packet sampling interval in the range of 2 to 60 seconds.
Usage guidelines
With this command configured, an IoT module sends only the sampled packets to the IoT gateway within each sampling interval.
Examples
# Set the location packet sampling interval to 5 seconds.
<Sysname> system-view
[Sysname] rfid-tracking iot sampling interval 5
Related commands
rfid-tracking iot sampling enable
rfid-tracking keepalive enable
Use rfid-tracking keepalive enable to enable wireless location keepalive.
Use undo rfid-tracking keepalive enable to disable wireless location keepalive.
Syntax
rfid-tracking keepalive enable
undo rfid-tracking keepalive enable
Default
Wireless location keepalive is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
This feature enables an IoT gateway to send Hello packets to the IoT server at an interval of 15 seconds. If the IoT server does not receive any packets from an IoT gateway within 30 seconds, the IoT server determines that the IoT gateway is offline.
Disable this feature to avoid bandwidth waste if the IoT server cannot process Hello packets. Enable this feature as required if the IoT server can process Hello packets.
This feature takes effect only when IoT location is enabled.
Examples
# Enable wireless location keepalive.
<Sysname> system-view
[Sysname] rfid-tracking keepalive enable
Related commands
rfid-tracking iot enable
serial-number
Use serial-number to specify a serial number for a module.
Use undo serial-number to restore the default.
Syntax
serial-number serial-number
undo serial-number
Default
No serial number is specified for a module.
Views
Module view
Predefined user roles
network-admin
Parameters
serial-number : Specifies a serial number to uniquely identify a module, a case-insensitive string of 1 to 31 characters.
Usage guidelines
CAUTION: Deleting the serial number or specifying a different serial number than the actual serial number of an online module logs off the module if the module connects to an IoT AP through network cables. |
This command is required for a module if the module connects to an AP through a network cable. The module can come online on the AP only when the specified serial number is the same as the actual serial number of the module.
For a module that is installed on an IoT AP, this setting does not take effect. The module can come online directly no matter whether the configured serial number is the same as the module's serial number or not.
Examples
# Specify the serial number of module 1 as 210235A1BSC123000050.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] serial-number 210235A1BSC123000050
tx-power
Use tx-power to set the transmit power level for a module.
Use undo tx-power to restore the default.
Syntax
tx-power power
undo tx-power
Default
The transmit power level is 1, which indicates a transmit power of 4 dBm.
Views
Module view
Predefined user roles
network-admin
Parameters
power: Specifies the transmit power level. The value can be 1, 2, 3, or 4, which indicates a transmit power of 4 dBm, –1 dBm, –5 dBm, and –9 dBm, respectively.
Examples
# Set the transmit power level to 4 for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] tx-power 4
type
Use type to specify the supported module type.
Use undo type to restore the default.
Syntax
type { ble | rfid | uwb }
undo type
Default
No supported module type is specified.
Views
Module view
Predefined user roles
network-admin
Parameters
ble: Specifies the Bluetooth low energy type.
rfid: Specifies the RFID type.
uwb: Specifies the UWB type.
Usage guidelines
For a module on an IoT gateway to operate correctly, the supported module type you specify must be consistent with its physical module type.
After you specify a module type for a module, the settings that are not supported by the module type will be deleted, and these settings are not configurable.
Examples
# Specify RFID as the supported module type for module 1.
<Sysname> system-view
[Sysname] iot module 1
[Sysname-iot-module-1] type rfid