set ekahau

Purpose

Configures Ekahau Client™ device-location software in a Digi Connect wireless device. The Ekahau Client feature provides integrated support for Ekahau's Wi-Fi device-location solution on wireless-enabled Digi devices. Ekahau offers a complete access point vendor-independent real-time location system for wireless LAN devices that is capable of pinpointing wireless LAN devices such as the Digi devices, laptops, PDAs, or other intelligent Wi-Fi enabled devices. The solution provides floor-, room- and door-level accuracy of up to 3.5 feet (1 m). The patented Ekahau positioning technology is based on simple signal-strength calibration maps, and enables customers to fully leverage an existing wireless LAN infrastructure without any need for proprietary hardware components.

Please visit www.ekahau.com for additional information, including free evaluation licenses for the Ekahau Positioning Engine and Ekahau Site Survey software products.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to set permissions s‑ekahau=read to display Ekahau client settings, and set permissions s‑ekahau=rw to display and configure Ekahau client settings. See set permissions for details on setting user permissions for commands.

Syntax

Configure Ekahau settings

set ekahau [state={on|off}]
  [id=device id]
  [poll_rate=seconds]
  [protocol={tcp|udp}]
  [port=port]
  [server={hostname|ip address}]
  [password=string]
  [name=string]

Display current Ekahau settings

set ekahau

Options

state={on|off}

Enables or disables the Ekahau Client feature.

The id, name, and server options must be set before you can set state to on.

id=device id

A numeric identifier for the Digi device, used internally by the Ekahau Positioning Engine for device tracking over time. This identifier should be unique for each Digi device being located on the network. It must be configured before the device will allow the state option to be set to on.

poll_rate=seconds

The time in seconds between each scan or wireless access points and communication with the server.

Once the Ekahau Client is enabled (state=on), every time the Digi device scans the network, it is disassociated with the access point (AP) providing its network connectivity. In addition, during the time, or scanning interval, set by the poll_rate option, it will not be receiving or transmitting wireless packets. This could lead to packet loss. Set the poll_rate as slow as acceptable in the application where the Digi device is being used.

The default is 5 seconds.

protocol={tcp|udp}

Specifies whether to use TCP or UDP as the network transport. The default is tcp.

port=port

The network port to communicate on. In the default Ekahau configuration, port 8548 is used for TCP, and port 8549 for UDP. This setting must be configured before the device will allow state to be set to on.

server={hostname|ip address}

The hostname or IP address of the Ekahau Positioning Engine. The maximum length of this option is 50 characters. The default is 8548.

password=password

A password to authenticate with the server. The maximum length of this option is 50 characters. The default password for Digi and the Ekahau Positioning Engine is Llama.

name=device name

A descriptive name to identify the Digi device to users. The maximum length of this option is 50 characters. This name must be configured before the device will allow state to be set to on.

Examples

Set identifiers

#> set ekahau id=1 server=myepe.domain.com name=”Tracked Device 1"

Enable Ekahau Client

#> set ekahau state=on