Sign inSign up

leapslabs/leaps_gateway

By leapslabs

Updated about 2 months ago

Image
0

4.5K

leapslabs/leaps_gateway repository overview

How to use this image

Start a leaps_gateway instance

docker run -d -it --name leaps_gateway --privileged -v /dev/bus/usb:/dev/bus/usb -v  %cd%/data/:/app/data leapslabs/leaps_gateway:tag /app/leaps-gateway -c /app/data/leaps-gateway.conf

where some_name is the name you want to assign to your container and tag is the tag specifying the leaps-gateway version you want. See the list above for relevant tags.

The leaps_gateway communicates on one side with the LEAPS UWBS via USB and on the other side with the LEAPS Server via the TCP/IP. Need to connect the gateway board to use.

Recommended run options

  • --user $(id -u):$(id -g) Run the instance under a specific user and group.
  • --restart unless-stopped Restart automatically the instance in case the server would crash.

Configuration

Using a custom configuration file

The leaps_gateway needs a configuration file to run so the -c option needs to be set with the path to the configuration file needs to be specified. The container contains a default leaps-gateway.conf located in /app/config/ folder. If you need to modify this configuration file, you can do it within the container or you can create a custom configuration file and mount it from the host machine to the container.

For example, /my/custom/leaps-gateway.conf is the path to the custom configuration file. Then start the leaps_gateway container as follows:

docker run -d -it --name leaps_gateway --privileged -v /dev/bus/usb:/dev/bus/usb -v  %cd%/data/:/app/data leapslabs/leaps_gateway:udk /app/leaps-gateway -c /app/data/leaps-gateway.conf

Configuration file example

#######################################################################
# LEAPS Gateway settings
#

# -----------------------------------------------------------------
# Overlay configuration
# -----------------------------------------------------------------
#

# Path to overlay configuration file.
# Comment out to disable storing/retrieving runtime configuration.
# overlay_cfg_file = /app/data/leaps-gateway-overlay.conf

# -----------------------------------------------------------------
# Logging
# -----------------------------------------------------------------
#

# Logging level, default is 3 (0=none, 1=error, 2=warning, 3=info,
# 4=debug, 5=verbose).
log_level = 3

# Path to log file. Comment out to disable logging to file (log to stdio instead).
# log = /app/data/leaps-gateway.log

# -----------------------------------------------------------------
# LEAPS Server
# -----------------------------------------------------------------
#

# LEAPS Server host
# Default: localhost
leaps_server_host = localhost

# LEAPS Server port
# Default: 7777
leaps_server_port = 7777

# -----------------------------------------------------------------
# TLS credentials
# -----------------------------------------------------------------
#

# Path to CA certificate file (PEM format), required when use_tls=1
# cafile = /app/data/certs/cacert.pem

# Path to client certificate file (PEM format), required when mutual_auth=1 & use_tls=1
# certfile = /app/data/certs/gwcert.pem

# Path to client private key file (PEM format), required when mutual_auth=1 & use_tls=1
# keyfile = /app/data/certs/gwkey.pem

# Enable TLS
# use_tls = 0

# Require mutual authentication
# mutual_auth = 1

# -----------------------------------------------------------------
# UWBS USB Device VID/PID
# -----------------------------------------------------------------
#

# Vendor ID, default is 0x1915, possible values are (0x1915-Nordic, 0x04d8-Microchip)
# Allowed values: 16-bit number in decimal, hexadecimal or octal format
# uwbs_usb_dev_vid = 0x04d8
uwbs_usb_dev_vid = 0x1915

# Product ID, default is 0xe8e3 for LEAPS RTLS devices
# Allowed values: 16-bit number in decimal, hexadecimal or octal format
uwbs_usb_dev_pid = 0xe8e3

# -----------------------------------------------------------------
# UWBS device configurations
# -----------------------------------------------------------------
#

# Bridge mode
# Allowed values: 0=Disable 1=Enable
# Default: (keep-current)
# uwbs_bridge = 0

# Initiator mode
# Allowed values: 0=Disable 1=Enable
# Default: (keep-current)
# uwbs_initiator = 0

# UWBMAC Profile ID
# Default: (keep-current)
# uwbs_profile_id = 0

# LEDs mode
# Allowed values: 0=Disable 1=Enable
# Default: (keep-current)
# uwbs_led = 1

# UWB encryption
# Allowed values: 0=Disable 1=Enable
# Default: (keep-current)
# uwbs_enc = 0

# UWB firmware update
# Allowed values: 0=Disable 1=Enable
# Default: (keep-current)
# uwbs_fwup = 0

# UWB mode
# Allowed values: 0=Off 1=Passive 2=Active
# Default: (keep-current)
# uwbs_uwb = 2

# UWB Backhaul Routing
# Allowed values: 0=Off 1=On 2=Auto
# Default: (keep-current)
uwbs_bh = 1

# BLE
# Allowed values: 0=Off 1=On
# Default: (keep-current)
# uwbs_ble = 1

# UWB encryption key
# Allowed values: 128-bit number in hexadecimal format
# Default: (keep-current)
# uwbs_enc_key = 11111111222222223333333344444444

# UWB network PANID
# Allowed values: 16-bit number in decimal, hexadecimal or octal format
# Default: (keep-current)
# uwbs_panid = 0x0000

# Device label
# Default: (keep-current)
# uwbs_label = gw-uwbs

# Device position in mm [x, y, z]
# Default: (keep-current)
# uwbs_pos_x = 0
# uwbs_pos_y = 0
# uwbs_pos_z = 0

Tag summary

Content type

Image

Digest

sha256:e76fb9d7a

Size

6.7 MB

Last updated

about 2 months ago

docker pull leapslabs/leaps_gateway