MQTT メッセージ参照


共通

anchor_config

フィールド

タイプ

ラベル

説明

イニシエーター

ブール値

必須

UWB initiator mode enable.

location

node_location

必須

Location of the node.

routing

routing_config

必須

Routing configuration.

bridge

ブール値

オプション

UWB bridge mode enable.


node_location

フィールド

タイプ

ラベル

説明

x

フロート

必須

X coordinate in meters.

y

フロート

必須

Y coordinate in meters.

z

フロート

必須

Z coordinate in meters.

品質

uint32

必須

Quality factor from 0% to 100%.

sd_x

フロート

オプション

Standard deviation of X coordinate in meters.

sd_y

フロート

オプション

Standard deviation of Y coordinate in meters.

sd_z

フロート

オプション

Standard deviation of Z coordinate in meters.

r95

フロート

オプション

R95 of locations in meters.

x_err

フロート

オプション

Error of X coordinate compared to reference location in meters.

y_err

フロート

オプション

Error of Y coordinate compared to reference location in meters.

z_err

フロート

オプション

Error of Z coordinate compared to reference location in meters.

toa

node_toa_measurement_statistics

繰り返し

Statistics of Time Of Arrival measurements.


node_status

フィールド

タイプ

ラベル

説明

origins

origin_info

繰り返し

List of origins.

profile

uwb_profile

オプション

Current UWB profile.

uwb

uwb_status

オプション

UWB status.

sensor

sensor_status

オプション

Status of the sensors.

route_active

ブール値

オプション

Indicate the gateway is a route candidate for the node.


node_toa_measurement_statistics

フィールド

タイプ

ラベル

説明

anchor_id

uint32

必須

Anchor ID.

sd_tdoa

フロート

必須

Standard deviation of Time of Arrival measurement.


origin_info

フィールド

タイプ

ラベル

説明

id

uint64

必須

hop_level

uint32

必須


sensor_status

フィールド

タイプ

ラベル

説明

batt

uint32

必須

Battery level in percents.

temp

int32

必須

Temperature in degrees.


service_data

フィールド

タイプ

ラベル

説明

タイプ

service_type

必須

Type of the service request or the type of the response. Refer to service_type.

データ

バイト

オプション

Opaque service data bytes encoded as base64.


signup_request

フィールド

タイプ

ラベル

説明

リリース

version_info

オプション

Version of the release.

ファームウェア

version_info

繰り返し

Version of the firmware.


signup_response

フィールド

タイプ

ラベル

説明

status

ブール値

必須

Statue/result of the signup.

ファームウェア

version_info

必須

Current version of the firmware.


tag_config

フィールド

タイプ

ラベル

説明

location_engine

ブール値

必須

Internal location engine enable.

low_power

ブール値

必須

Low power mode enable.

stationary_detection

ブール値

必須

Stationary detection enable.

update_rate_nominal

uint32

必須

Nominal update rate in multiply of superframe interval.

update_rate_stationary

uint32

必須

Stationary update rate in multiply of superframe interval..

reference_location

node_location

オプション

Reference location of the tag.


uwb_profile

フィールド

タイプ

ラベル

説明

sfn_range

uint32

必須

Superframe number range.

microseconds_per_sf

uint32

必須

Microseconds per superframe.

microseconds_per_slot

uint32

必須

Microseconds per slot.

update_rate_default

uint32

必須

Update rate is in multiple of superframes.

uplink_latency

uint32

オプション

Number of slots to wait before the time of arrival data that has been received are processed by the internal location engine.

node_signup_optional

ブール値

オプション

Setting this to "true" means that signup is not required for any of the edge nodes (not gateway nodes), signup is required by default if this parameter is not set or if it is set to "false".

latency

uint32

オプション

Ethernet latency in number of superframes, the latency is considered when sending downlink, latency is supposed ot be 0 if this is not set

max_buffer_size_downlink

uint32

オプション

Size is supposed to be unlimited if not set.


version_info

フィールド

タイプ

ラベル

説明

maj

uint32

必須

min

uint32

必須

patch

uint32

必須

var

uint32

オプション


wifi_config

フィールド

タイプ

ラベル

説明

ssid

文字列

必須

パスワード

文字列

必須

地域

wifi_region

オプション


interface_config

名前

数値

説明

ETHERNET

0

WIFI

1


mac_address_type

名前

数値

説明

EMPTY

0

MAC address is empty meaning that the interface is not present.

DEFAULT

1

Default MAC address (cannot be changed).

USER_SPECIFIED

2

MAC address specified by the user (can be changed).

MUTABLE_DEFAULT

3

Default MAC address that can be changed only once by the user.


routing_config

名前

数値

説明

ROUTING_OFF

0

UWB routing is turned off.

ROUTING_ON

1

UWB routing is active.

ROUTING_AUTO

2

Automatic UWB routing.


service_type

名前

数値

説明

GET_CONFIG

0

Request to send configuration.

TLV_API_CMD

1

TLV API command.

TLV_API_ACK

2

TLV API command positive acknowledge.

TLV_API_NACK

3

TLV API command negative acknowledge.


tls_config

名前

数値

説明

OFF

0

TLS/SSL turned off.

SERVER

1

TLS authentication of server.

MUTUAL

2

Two way TLS authentication of server and the gateway/client.

SERVER_CN

3

TLS authentication of server with checking of the 'Common Name'.

MUTUAL_CN

4

Two way TLS authentication of server and the gateway/client with checking of the 'Common Name'.


uwb_mode_config

名前

数値

説明

UWB_MODE_OFFLINE

0

UWB_MODE_PASSIVE

1

UWB_MODE_ACTIVE

2


uwb_status

名前

数値

説明

切断されました

0

Disconnected from the UWB network.

已连接

1

Connected to the UWB network.

接続されました

2

Connected, backhaul possible.

UPDATING_FW

3

UWB firmware update is in progress.

UWBS_INACTIVE

4

Data from UWBS is not coming.


wifi_region

名前

数値

説明

EUROPE

0

NORTH_AMERICA

1

ASIA

2


leaps_api

leaps_api.inet_config

TCP/IP configuration options.

フィールド

タイプ

ラベル

説明

ip

leaps_api.ip_config

繰り返し

IP configuration.

dns

文字列

繰り返し

DNS host.

iface

interface_config

必須

Interface selection.

tls

tls_config

必須

TLS/SSL configuration.

dhcp

ブール値

必須

DHCP enabled?

mac_filter

ブール値

必須

MAC filter enabled?

サーバー

leaps_api.inet_config.server_config

必須

Leaps server configuration.


leaps_api.inet_config.server_config

フィールド

タイプ

ラベル

説明

host

文字列

必須

Leaps server host configuration.

port

uint32

必須

Leaps server port configuration.


leaps_api.ip_config

フィールド

タイプ

ラベル

説明

addr

文字列

必須

IP address.

mask

文字列

オプション

IP address mask.

ゲートウェイ

文字列

オプション

Gateway IP address.


leaps_api.location

Topic: {prefix}/{panId/}node/uplink/location/{deviceId}.

フィールド

タイプ

ラベル

説明

location

node_location

必須

Location of the device.

タイムスタンプ

uint64

オプション

Timestamp in microseconds.


leaps_api.mac_config

Configuration of the MAC address.

フィールド

タイプ

ラベル

説明

addr

文字列

必須

MAC address in dot-notation.

タイプ

mac_address_type

必須

Type of the MAC address. Refer to mac_address_type.

iface

文字列

必須

Interface that the MAC address belong to. Refer to mac_address_interface.


leaps_api.node_config

Topic: {prefix}/{panId/}{node|gateway}/{uplink|downlink}/config/{deviceId}.

フィールド

タイプ

ラベル

説明

ラベル

文字列

必須

Device label.

uwb_mode

uwb_mode_config

必須

UWB mode configuration.

ble

ブール値

必須

BLE enabled?

leds

ブール値

必須

LEDs enabled?

fw_update

ブール値

必須

Firmware update enabled?

アンカー

anchor_config

オプション

Anchor-specific configuration.

タグ

tag_config

オプション

Tag-specific configuration.

inet

leaps_api.inet_config

オプション

TCP/IP configuration

wifi

wifi_config

オプション

Wi-Fi configuration.

mac

leaps_api.mac_config

繰り返し

MAC address configuration.

タイムスタンプ

uint64

オプション

Timestamp in microseconds.


leaps_api.server_message

Leaps server status uplink topic: {prefix}/server/status. Leaps server request downlink topic: {prefix}/server/request.

フィールド

タイプ

ラベル

説明

状態

文字列

オプション

Status of the Leaps server. Refer to server_state.

バージョン

文字列

オプション

Leaps Server version.

リクエスト

文字列

オプション

Request to the Leaps server. Refer to leaps_api.server_request.

ノードリスト

leaps_api.server_message.node_list

繰り返し

List of the devices managed by the Leaps server.

networks

leaps_api.server_message.network

繰り返し

Optional list of networks to address the request to a specific UWB network(s). If The list is empty, the request is addressed to all known UWB networks managed by the server.


leaps_api.server_message.network

フィールド

タイプ

ラベル

説明

id

uint32

オプション

Network ID (PAN ID)

名前

文字列

オプション

Known network name/alias.

leaps_api.server_message.node_list

フィールド

タイプ

ラベル

説明

ネットワーク

uint32

必須

UWB网络panID。

ノード

文字列

繰り返し

UWB ノード ID/アドレス (16 進数)。


leaps_api.service_data

Topic: {prefix}/{panId/}node/{uplink|downlink}/service/{deviceId}.

フィールド

タイプ

ラベル

説明

タイプ

service_type

必須

Type of the server data.

データ

バイト

オプション

The data bytes encoded as base64.

タイムスタンプ

uint64

オプション

Timestamp in microseconds.


leaps_api.status

Topic: {prefix}/{panId}/{node|gateway}/uplink/status/{deviceId}.

フィールド

タイプ

ラベル

説明

現在

ブール値

必須

Device is present or missing?

ダウンリンク

ブール値

オプション

Sending downlink to the device is possible?

uwb

uwb_status

オプション

Status of the UWB layer.

batt

uint32

オプション

Battery status in percents.

temp

int32

オプション

Temperature in degrees.

origins

origin_info

繰り返し

List of UWB origins.

profile

uwb_profile

オプション

Current UWB profile status.

タイムスタンプ

uint64

オプション

Timestamp in microseconds.


leaps_api.user_data

Topic: {prefix}/{panId}/node/{uplink|downlink}/data/{deviceId}.

フィールド

タイプ

ラベル

説明

データ

バイト

必須

The data bytes encoded as base64.

上書き

ブール値

オプション

Overwrite the pending data?

タイムスタンプ

uint64

オプション

Timestamp in microseconds.


leaps_api.mac_address_interface

Supported interfaces in terms of MAC addresses configuration.

名前

数値

説明

UWB

0

BLE

1

ETHERNET

2

WIFI

3


leaps_api.server_request

Leaps server request downlink topic: {prefix}/server/request.

名前

数値

説明

服务器请要求

0

非推奨: PUBLISH_ALL_TOPICS と同じ

PUBLISH_NODE_LIST

1

現在のノードのリストを公開します。

PUBLISH_ALL_TOPICS

2

すべてのノードのすべてのメッセージをただちに公開するようリクエストします。


leaps_api.server_state

名前

数値

説明

切断されました

0

Leaps サーバーがシャットダウンされました。

已连接

1

Leaps サーバーは準備ができており、実行中です