Skip to main content
Version: ROS 2 Jazzy

Wireless

The wireless section configures wireless networking nodes that run on the robot, including the wireless watcher and any supported external wireless devices such as routers or base stations.

KeyValue / DatatypeDescription
routerSee belowConfiguration for an onboard wireless router (e.g. a Peplink router installed on the robot). Default: null (no router).
base_stationSee belowConfiguration for an external base station router (using the same schema as router). Default: null (no base station).
enable_wireless_watcherbooleanEnables or disables the wireless watcher node. Default: true.

For example:

platform:
wireless:
enable_wireless_watcher: true
router:
model: peplink
ip_address: 192.168.131.51
username: admin
password: admin
enable_gps: false
publish_passwords: false

Wireless Watcher

By default, all Clearpath platforms launch a Wireless Watcher node. This node monitors the computer's integrated wireless interface connection. Some applications may not use this integrated wireless connection, in which case the wireless watcher node can be disabled, although it can be left enabled without negative ramifications.

For example, to disable the wireless watcher node:

platform:
wireless:
enable_wireless_watcher: false
note

The platform.enable_wireless_watcher key is deprecated and has been moved to platform.wireless.enable_wireless_watcher. The legacy key still works for backwards compatibility, but new configurations should use the wireless section.

Router

The router and base_station entries share a common schema. The router entry describes a wireless router installed on the robot, while the base_station entry describes an external router (e.g. mounted at a fixed location) that the robot communicates with.

The available options depend on the model. The currently supported models are listed below.

Common Options

KeyValue / DatatypeDescription
modelstringThe router model. Required. Currently only peplink is supported.
ip_addressstringThe IPv4 address of the router on the robot's network.
launch_enabledbooleanWhether the driver node for this router should be launched. Default: true.

When model is set to peplink, the peplink_router_driver package is used to communicate with the router over its web API.

KeyValue / DatatypeDescription
ip_addressstringThe IPv4 address of the Peplink router. Default: 192.168.131.51.
usernamestringThe username used to authenticate with the router's web API. Default: admin.
passwordstringThe password used to authenticate with the router's web API. Default: admin.
enable_gpsbooleanIf true, the driver publishes GPS data reported by the router (for routers equipped with GPS). Default: false.
publish_passwordsbooleanIf true, Wi-Fi passwords reported by the router are published on the corresponding ROS topics. Default: false.

For example, configuring an onboard Peplink router and an external Peplink base station:

platform:
wireless:
router:
model: peplink
ip_address: 192.168.131.51
username: admin
password: admin
enable_gps: true
publish_passwords: false
base_station:
model: peplink
ip_address: 192.168.131.52
username: admin
password: admin