⚠️ If you have not already done so, please read the Basic setup section of the manual. It will be referenced frequently.
⚠️ Please note that the interface described in this file will be subject to change as the project matures. It is not recommended to use this module without a dedicated wireless interface yet as it will disrupt other network stacks.
⚠️ Only Linux is currently supported.
If you wish to use the network autoconfiguration features, NetworkManager must be installed and running on your machine. The interface requires privileges as it accesses Linux's ethernet network stack directly.
At the moment, there are 3 ways of using the raw networking module
that powers the wifi connectivity depending on how you supply the
configuration to the module. The configuration fields of interest are
datalink-iface. The first expects the utf-8
ONLY ssid name and the second expects the OS's interface name, such
as wlan0, wlp1s0, wlo0, etc. They can be configured as follows:
Remove the SSID field from config.json and only supply the interface field. The endpoint will attempt to connect directly to the given device. This works well for accessing local peers over wifi or ethernet and in cases where manual configuration of the wireless device is desired.
Provide both the SSID and interface fields. The endpoint will then attempt to use NetworkManager to scan for the given SSID and connect to it. If it is not found, a new ad-hoc network will be created that can then be joined from other device.
Provide only the SSID and remove interface field. The endpoint will attempt to scan over all available wireless interfaces to find the given SSID. If it is not found, a device will be picked and a new ad-hoc network will be created that can then be joined from other devices.
Advanced configuration (manual)
It would be nice to support Wi-Fi Direct and VIF auto-configuration on Linux. These can currently be manually configured with your tool of choice (iw, wpa_supplicant, etc.) and used in ratman via the first configuration method.
Ratman panics on startup
Ensure that you have the correct permissions. This means you can either run the process as root (not recommended) or with CAP_NET_RAW and CAP_NET_ADMIN.
You should be able to set the required permissions by running the following
command as root:
setcap cap_net_raw,cap_net_admin+eip [path/to/ratmand]
man capabilities and
man setcap for more details.
Network Manager configuration times out
This is generally due to issues with device drivers. There's a good chance that your device drivers:
- are improperly configured
- are buggy
- do not support being set to AP mode
The devs are working on a list of recommended hardware.
Why can't I connect to the internet?
This endpoint captures all packets sent to the given device. If you had any higher level network protocols operating on it, you're out of luck at the moment. This may change in the future.