Overview

This article describes the available members in the Smartspot configuration object. This list is sorted alphabetically by the configuration object members.

Configuration object members

`alive_ds` Brain communication interval

This is the interval whereby the device communicates with the Brain. The value is specified as a number in deciseconds (1/10 of a second).

Type: Number
Unit: deciseconds
Range: 1-600
Default: 10

Example:

"alive_ds": 10

Changing this setting from the default value, can have severe negative impact on the device's performance.

`ant_presence` Enable or disable antenna presences

Enable this setting to assign two or more locations to this device. Disable if all antennas are assigned to a single location.

Type: Boolean
Default: false

Example:

"ant_presence": false

`ant_report_ds` Antenna presence report interval

When enabled, the device collects statistical data per item and antenna instead of data per item for all antennas. The data from these reports will improve the localization algorithm. A value of 0 indicates that no reports are sent. Please note that this functionality requires ant_presence to be enabled. The value of this setting is defined in deciseconds (1/10 of a second).

Type: Number
Unit: deciseconds
Range: 0-72000
Default: 0

Example:

"ant_report_ds": 10

`antenna_disable_mask` Antenna disable mask

Bit mask to enable/disable antennas. A high bit1 means that the antenna is disabled, a low bit0 means that the antenna is enabled

Type: Number
Width: 25 bits
Default: 0

Example:

// Enable all antennas, except for antenna number 2
// Ant. nr.: 8 7 6 5 4 3 2 1
// Bit. nr.: 8 7 6 5 4 3 2 1
// Base 2  : 0 0 0 0 0 0 1 0
// Base 10 : 0 0 0 0 0 0 0 2
"antenna_disable_mask": 2

`auto_hold_delay` Auto hold delay

Enable or disable automatic hold delay. When enabled, the hold delay will be automatically increased based on the actual number of presences on the device.

Type: Boolean
Default: true

Example:

"auto_hold_delay": false

`brain_address` Brain address

Brain IP address / URL

Type: String
Default: "brain.intellifi.nl"

Example:

"brain_address": "example.intellifi.nl"

`bt_antenna_map` Bluetooth antenna map

List of paired external readers with Bluetooth Low Energy connectivity, such as the Micro spot BLE relay.
Consists of key-value pairs with a BLE MAC address (in lowercase hexadecimal) as key and a virtual antenna number as value.
When a device's MAC address is added to this map, the Smartspot will always attempt to establish a connection with that device and report its readings as readings from the specified antenna number (max. 255, recommended 50-59). The number of devices that can be paired is limited to eight.

Type: Object
Default: {}

Example:

"bt_antenna_map": {"f99133484cc8": 50, "ecb183f96524": 51}

This setting can only be used on a Smartspot BLE only.

`bt_beacon_emit` Bluetooth beacon emit

If set to true, the Smartspot will periodically act as a Bluetooth Low Energy beacon, transmitting BLE advertisements in the Apple iBeacon format. If set to false, the Smartspot will not transmit BLE advertisements.

Type: Boolean
Default: false

Example:

"bt_beacon_emit": true

`bt_beacon_recv` Bluetooth beacon receive

If set to true, enables Bluetooth Low Energy advertisement reading. If set to false, the Smartspot will ignore received BLE advertisements.

Type: Boolean
Default: true

Example:

"bt_beacon_recv": "true"

`bt_hysteresis` Bluetooth proximity hysteresis

Change this level to adjust proximity determination. Increase this value if you are switching too often between proximity values.

Type: Number
Unit: dBm * 10
Range: 0-200
Default: 30

Example:

"bt_hysteresis": 20

`bt_immediate` Bluetooth proximity immediate

Change this level to adjust proximity determination. Make sure that your immediate level is bigger than your near level.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -550

Example:

"bt_immediate": -450

`bt_min_window_size` Bluetooth min window size

A higher value adds more filtering to incoming tag reads. This stabilizes for signal fluctuations, but makes the proximity updates a bit slower. The filter characteristics are similar to a moving average filters while using a dynamic windows size which depends on sample inflow and the value of min window size setting.

Type: Number
Range: 1-200
Default: 1

`bt_max_window_size` Bluetooth max window size

A higher value raises the maximum filter window size to accommodate more filtering to incoming tag reads at high data inflow. This stabilizes for signal fluctuations, but makes the proximity updates a bit slower. The filter characteristics are similar to a moving average filters while using a dynamic windows size which depends on sample inflow and the value of min window size setting.

Type: Number
Range: 1-200
Default: 10

Example:

"bt_max_window_size": 20

`bt_near` Bluetooth proximity near

Change this level to adjust proximity determination. Make sure that your immediate level is bigger than your near level.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -650

Example:

"bt_near": -550

`bt_threshold` Bluetooth item threshold

Bluetooth items with an RSSI below this threshold are ignored.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -900

Example:

"bt_threshold": -800

`closest_hold_ds` Closest item algorithm hold time

In the closest item algorithm, a sample is considered stale after this time.

Type: Number
Range: 5-6000
Default: 125

Example:

"closest_hold_ds": 150

`closest_hysteresis` Closest item algorithm hysteresis

In the closest item algorithm, a sample is only considered significantly stronger or weaker than another sample if the difference is greater than the hysteresis.

Type: Number
Unit: dBm * 10
Range: 0-1000
Default: 23

Example:

"closest_hysteresis": 30

`closest_min_rssi` Closest item algorithm min. RSSI

In the closest item algorithm, this value is the lower threshold for acceptable samples.

Type: Number
Unit: dBm * 10
Range: -1200 to 0
Default: -500

Example:

"closest_min_rssi": -450

`compress_events` Compress events

Compress events communication send from the device to the Brain.

Type: Boolean
Default: true

Example:

"compress_events": true

Changing this setting from the default value, can have severe negative impact on the device's performance.

`control_schema` Sense&Control schema

Apply JSON based local Sense&Control scheme; See the Sense&Control section for more details.

Type: Object

Default:

{
    "links": {
      "snd2": "boot",
      "ledg": "tick",
      "ledr": "hit",
      "out1": "hit",
      "out2": "hit",
      "ledfg": "s",
      "ledfr": "!1o",
      "!1i": "s"
    }
  }

Example:

"control_schema": {}

`dashboard_address` Dashboard address

Dashboard IP address / URL.

Type: String
Default: dashboard.intellifi.nl

Example:

"dashboard_address": "dashboard.intellifi.nl"

Changing this setting from the default value, can have severe negative impact on the device's performance.

`dashboard_period_s` Dashboard communication interval

This is the interval whereby the device communicates with the dashboard. The value is specified as a number in seconds.

Type: Number
Range: 60-172800
Default: 900 (15 minutes)

Example:

"dashboard_period_s": 300

Changing this setting from the default value, can have severe negative impact on the device's performance.

`dashboard_reconnect` Dashboard reconnect

Reconnect to the dashboard.

Type: Boolean
Default: true

Example:

"dashboard_reconnect": true

Changing this setting from the default value, can have severe negative impact on the device's performance.

`dns_primary` DNS primary

DNS resolve URL primary.

Type: String
Default: 208.67.222.222 (resolver1.opendns.com)

Example:

"dns_primary": "1.1.1.1"

`dns_secondary` dns_secondary

DNS resolve URL secondary.

Type: String
Default: 208.67.220.220 (resolver2.opendns.com)

Example:

"dns_secondary": "1.1.1.1"

`fixed_hold_delay_s` Fixed hold time

Set the maximum item hold time in seconds. The hold time keeps an item present for the maximum time defined by this hold time setting. Each time this particular item is detected again, the hold time will be reset to the start value and the countdown starts again.

This will only be used if auto_hold_delay is disabled.

Type: Number
Unit: seconds
Range: 1-3600
Default: 10

Example:

"fixed_hold_delay_s": 30

`gateway` Gateway

Gateway address.

Type: String
Default: varies per network

Example:

"gateway": "192.168.0.1"

`hostname` Hostname

The hostname that will identify the device on the network it is connected to.

Type: String
Default: varies per device (e.g. Spot1234)

Example:

"hostname": "somehostname"

`ip` IP address

The IP Address of the device. Do not change this setting when use_dhcp is enabled.

Type: String
Default: varies per device and network

Example:

"ip": "192.168.0.42"

`max_antenna_swr` Maximum antenna SWR value

The device will do an impedance check on the connected antennas and this is the limit for when the antenna is seen as disconnected.

Type: Number
Range: 0-4000
Default: 3500

Example:

"max_antenna_swr": 3000

`mux_type` RFID Multiplexer type

What type of RFID multiplexer is used. Depends on the type of Smartspot and should not be changed under normal circumstances.

Type: Number

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_action` RFID action

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-7
Default: 0

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_antenna_sequence` RFID antenna sequence

The antenna sequence defines the sequence of which antennas are scanned. This option is very similar to the antenna_disable_mask. Whereas the antenna_disable_mask can only disable antennas, the rfid_antenna_sequence can be used to disable antennas and control the scanning sequence.

When the array is empty, all the antennas are being used in the default scanning order of the device. When antennas are specified in the array, only antennas in that array are being scanned in the order of the sequence in the array.

Type: Array
Default: []

Example:

"rfid_antenna_sequence": [1, 2]

This setting can only be used on a Smartspot Focus.

`rfid_blf` RFID backlink frequency

Internal EPC Gen2 parameter that should not be changed under normal circumstances. Automatically adjusted based on RFID region.

Type: Number
Range 0-7
Default: 3

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_channel` RFID Channel

Configures the channel this reader is operating on. Can be channel 1 to 4.

Type: Number
Range: 1-4
Default: 1

Example:

"rfid_channel": 2

This setting can only be changed when the region is set to Europe.

`rfid_on_time_ms` RFID transmitter on-time in milliseconds

Configures the radio transmitter working (on) time.

Type: Number
Range: 50-4000
Default: 4000

Example:

"rfid_on_time_ms": 4000

This setting can only be changed when the region is set to Europe and the lower band (865-868 MHz) in being used.

`rfid_off_time_ms` RFID transmitter off-time in milliseconds

Configures the radio transmitter idle (off) time.

Type: Number
Range: 100-4000
Default: 100

Example:

"rfid_off_time_ms": 100

This setting can only be changed when the region is set to Europe and the lower band (865-868 MHz) in being used.

`rfid_code_mode` Selects code representation and enables TID

This setting allows you to select data to be used for Item code. Also this settings controls if the TID memory block is read. If this settings is greater than 0, the Smartspot tries to read the TID memory block after each EPC inventory and if successful, uses the data depending on setting value.

Type: Number
Default: 0
Values available:
- 0: Item code is EPC, no TID memory will be read.
- 1: Item code is EPC, TID as extended Item data.
- 2: Item code is TID serial number, EPC and TID as extended Item data.

Example:

"rfid_code_mode": 0

Changing this setting from the default value, can have severe negative impact on the device's performance. Tag inventories slow down dramatically to circa 1 tag/sec.

`rfid_continues` RFID continues inventory

Enable continuous inventory (true), or restart inventory at every antenna switch (false).

Type: Boolean
Default: true

Example:

"rfid_continues": false

`rfid_dr` RFID divide ratio

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-1
Default: 1

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_enable` RFID enable

Enable or disable RFID scanning.

Type: Boolean
Default: true

Example:

"rfid_enable": "true"

This setting is only applicable for devices with an integrated RFID module.

`rfid_hysteresis` RFID proximity hysteresis

Change this level to adjust proximity determination. Increase this value if you are switching too often between proximity values.

Type: Number
Unit: dBm * 10
Range: 0-200
Default: 25

Example:

"rfid_hysteesis": 20

`rfid_immediate` RFID proximity immediate

Change this level to adjust proximity determination. Make sure that your immediate level is bigger than your near level.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -550

Example:

"rfid_immediate": -450

`rfid_m` RFID M-setting

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-3
Default: 2

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_max_q` RFID maximum Q value

Maximum value for automatic Q parameter algorithm. Setting this to the same value as rfid_min_q will result in a fixed Q parameter.

Type: Number
Range: 0-15
Default: 15

Example:

"rfid_max_q": 4

`rfid_min_window_size` RFID min window size

Type: Number
Range: 1-200
Default: 1

`rfid_max_window_size` RFID max window size

Type: Number
Range: 1-200
Default: 1

Example:

"rfid_max_window_size": 10

`rfid_min_q` RFID minimum Q value

Minimum value for automatic Q parameter algorithm. Setting this to the same value as rfid_max_q will result in a fixed Q parameter.

Type: Number
Range: 0-15
Default: 0

Example:

"rfid_min_q": 4

`rfid_near` RFID proximity near

Change this level to adjust proximity determination. Make sure that your immediate level is bigger than your near level.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -660

Example:

"rfid_near": -550

`rfid_period_ms` RFID scanning period per antenna

How long the device will scan over a single antenna. The value is defined in milliseconds (1/1000 of a second).

Type: Number
Unit: milliseconds
Range: 50-10000
Default: 250

Example:

"rfid_period_ms": 500

`rfid_power_dbm` RFID power output

Change this value to adjust reading range of the reader as desired.

The table below gives an indication of the maximum reading distance for some given transmit power and optimal conditions.

RFID Power output (dBm)	5	10	15	20	22	24	26	28	30
max. distance (m)	0,7	1,2	2,2	3,8	4,8	6,1	7,7	9,7	12,2

Type: Number
Unit: dBm
Range: 5-30
Default: 27

Example:

"rfid_power_dbm": 27

`rfid_region` RFID region

Configures the region that the RFID reader is operating in. Please note that the setting for Japan is invalid. Japan moved the RFID band to 916-921 MHz, 952-953 MHz is not allowed anymore.

Value	Region	Frequency band (MHz)
1	Europe	865-867
2	USA	902-928
3	China 1	840-844
4	China 2	920-924
5	Korea	917-923
6	Japan	952-953 (do not use)

Type: Number
Default: 1

Example:

"rfid_region": 2

An incorrect region setting may cause the device to violate local radio transmission regulations.

`rfid_sel` RFID query select

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-3
Default: 1

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_session` RFID query session

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-3
Default: 1

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_target` RFID target

Internal EPC Gen2 parameter that should not be changed under normal circumstances.

Type: Number
Range: 0-5
Default: 0

Changing this setting from the default value, can have severe negative impact on the device's performance.

`rfid_threshold` RFID item threshold

RFID items with an RSSI below this threshold are ignored.

Type: Number
Unit: dBm * 10
Range: -1000 to 0
Default: -900

Example:

"rfid_threshold": -800

`send_hits` Send hits

Enable or disable the spot to send raw read data on telnet port.

Type: Boolean
Default: false

Example:

"send_hits": true

Changing this setting from the default value, can have severe negative impact on the device's performance.

`sntp_address` Simple Network Time Protocol

Timeserver for internal time synchronization.

Type: String
Default: 0.pool.ntp.org

Example:

"sntp_address": "0.pool.ntp.org"

`subnet` Subnetwork

Subnetwork of the device.

Type: String
Default: varies per network

Example:

"subnet": "255.255.255.0"

`use_dhcp` Use DHCP

Use the DHCP server to get an IP address, or use a static IP address. The IP address of the device can be found via the Device management of the Brain, via the Smartspot web-interface or by reverse lookup via the MAC address, see How to find the MAC address of a Smartspot.

Type: Boolean
Default: true

Example:

"use_dhcp": false

`zones` Antenna grouping into zones

Antennas can be grouped into zones using this setting. This will give the following advantages:

Grouping a bunch of antennas that represent a bigger group(zone) will make the handling of the location assignment on the Brain less complicated.
Grouping multiple antennas into a single zone will reduce the upstream event data to the Brain. Which increase performance and real time behavior.

The Brain will still represent zones as antenna numbers, this means that a zone number, for example, "1" will represent itself as antenna 1 on the Brain.

Type: Object
Zone object member:
- Zone number as String type
  - Array of antennas (Numbers)
Default: {}

Example:

Mapping antenna 1 and 3 to zone "1" and antenna 2 and 4 to zone "3". The Brain will represent, as within this example, zone "1" as antenna 1 and zone "2" as antenna 2:

"zones": {
  "1": [ 1, 3 ],
  "2": [ 2, 4 ]
}

This setting is only applicable when ant_presence is enabled.

Articles in this section

Overview

Configuration object members

alive_ds Brain communication interval

ant_presence Enable or disable antenna presences

ant_report_ds Antenna presence report interval

antenna_disable_mask Antenna disable mask

auto_hold_delay Auto hold delay

brain_address Brain address

bt_antenna_map Bluetooth antenna map

bt_beacon_emit Bluetooth beacon emit

bt_beacon_recv Bluetooth beacon receive

bt_hysteresis Bluetooth proximity hysteresis

bt_immediate Bluetooth proximity immediate

bt_min_window_size Bluetooth min window size

bt_max_window_size Bluetooth max window size

bt_near Bluetooth proximity near

bt_threshold Bluetooth item threshold

closest_hold_ds Closest item algorithm hold time

closest_hysteresis Closest item algorithm hysteresis

closest_min_rssi Closest item algorithm min. RSSI

compress_events Compress events

control_schema Sense&Control schema

dashboard_address Dashboard address

dashboard_period_s Dashboard communication interval

dashboard_reconnect Dashboard reconnect

dns_primary DNS primary

dns_secondary dns_secondary

fixed_hold_delay_s Fixed hold time

gateway Gateway

hostname Hostname

ip IP address

max_antenna_swr Maximum antenna SWR value

mux_type RFID Multiplexer type

rfid_action RFID action

rfid_antenna_sequence RFID antenna sequence

rfid_blf RFID backlink frequency

rfid_channel RFID Channel

rfid_on_time_ms RFID transmitter on-time in milliseconds

rfid_off_time_ms RFID transmitter off-time in milliseconds

rfid_code_mode Selects code representation and enables TID

rfid_continues RFID continues inventory

rfid_dr RFID divide ratio

rfid_enable RFID enable

rfid_hysteresis RFID proximity hysteresis

rfid_immediate RFID proximity immediate

rfid_m RFID M-setting

rfid_max_q RFID maximum Q value

rfid_min_window_size RFID min window size

rfid_max_window_size RFID max window size

rfid_min_q RFID minimum Q value

rfid_near RFID proximity near

rfid_period_ms RFID scanning period per antenna

rfid_power_dbm RFID power output

rfid_region RFID region

rfid_sel RFID query select

rfid_session RFID query session

rfid_target RFID target

rfid_threshold RFID item threshold

send_hits Send hits

sntp_address Simple Network Time Protocol

subnet Subnetwork

use_dhcp Use DHCP

zones Antenna grouping into zones

Related articles

`alive_ds` Brain communication interval

`ant_presence` Enable or disable antenna presences

`ant_report_ds` Antenna presence report interval

`antenna_disable_mask` Antenna disable mask

`auto_hold_delay` Auto hold delay

`brain_address` Brain address

`bt_antenna_map` Bluetooth antenna map

`bt_beacon_emit` Bluetooth beacon emit

`bt_beacon_recv` Bluetooth beacon receive

`bt_hysteresis` Bluetooth proximity hysteresis

`bt_immediate` Bluetooth proximity immediate

`bt_min_window_size` Bluetooth min window size

`bt_max_window_size` Bluetooth max window size

`bt_near` Bluetooth proximity near

`bt_threshold` Bluetooth item threshold

`closest_hold_ds` Closest item algorithm hold time

`closest_hysteresis` Closest item algorithm hysteresis

`closest_min_rssi` Closest item algorithm min. RSSI

`compress_events` Compress events

`control_schema` Sense&Control schema

`dashboard_address` Dashboard address

`dashboard_period_s` Dashboard communication interval

`dashboard_reconnect` Dashboard reconnect

`dns_primary` DNS primary

`dns_secondary` dns_secondary

`fixed_hold_delay_s` Fixed hold time

`gateway` Gateway

`hostname` Hostname

`ip` IP address

`max_antenna_swr` Maximum antenna SWR value

`mux_type` RFID Multiplexer type

`rfid_action` RFID action

`rfid_antenna_sequence` RFID antenna sequence

`rfid_blf` RFID backlink frequency

`rfid_channel` RFID Channel

`rfid_on_time_ms` RFID transmitter on-time in milliseconds

`rfid_off_time_ms` RFID transmitter off-time in milliseconds

`rfid_code_mode` Selects code representation and enables TID

`rfid_continues` RFID continues inventory

`rfid_dr` RFID divide ratio

`rfid_enable` RFID enable

`rfid_hysteresis` RFID proximity hysteresis

`rfid_immediate` RFID proximity immediate

`rfid_m` RFID M-setting

`rfid_max_q` RFID maximum Q value

`rfid_min_window_size` RFID min window size

`rfid_max_window_size` RFID max window size

`rfid_min_q` RFID minimum Q value

`rfid_near` RFID proximity near

`rfid_period_ms` RFID scanning period per antenna

`rfid_power_dbm` RFID power output

`rfid_region` RFID region

`rfid_sel` RFID query select

`rfid_session` RFID query session

`rfid_target` RFID target

`rfid_threshold` RFID item threshold

`send_hits` Send hits

`sntp_address` Simple Network Time Protocol

`subnet` Subnetwork

`use_dhcp` Use DHCP

`zones` Antenna grouping into zones