Setting Mode
Devices are not in a state to accept configurations by default. You must switch the device to Setting Mode to change network and other settings.
There are several ways to enter Setting Mode:
- Devices with buttons: Long-press the button, or power on the device while holding the button.
- Via UART (if Console is enabled): Enter the specific command through UART to switch to Setting Mode.
- Automatic Transition: If the device fails to connect to any saved networks, it will automatically enter Setting Mode. (This feature can be disabled on OS7 or later by providing
setting_modeconfigration )
In Setting Mode, the device broadcasts its own Wi-Fi signal. You can configure the device by connecting to this Wi-Fi network.
Button Locations and Operations
For devices equipped with a configuration button, use the following operations to enter Setting Mode:
| Product | Button Location | Operation |
|---|---|---|
| obniz Board / 1Y | Dial | Press and hold the dial while powering on. |
| M5Stack Basic | Center button | Press and hold the button while powering on. |
| M5StickC | Button B (Side) | Press and hold the button while powering on. |
| obniz BLE/Wi-Fi Gateway Gen2.0 | Side (marked with □) | Touch and hold for several seconds. |
| obniz BLE/LTE Gateway | Front square button | Press and hold for several seconds. |
Note: The device will automatically restart if it remains inactive for a certain period.
Saved Network Settings
In obnizOS, settings to connect to the cloud are needed to be stored on the device.
The following non-volatile settings (settings that are saved even when the power is turned off) are available for this purpose.
| Setting contents | Contents | Setting method |
|---|---|---|
| Device Key | Key to recognize the device | Console or Generated by a device |
| Component settings | Wiring information to external LTE modem and etc | Console/Display/Browser/Internet |
| Network settings | Settings like Wi-Fi password for connecting to Network | Console/Display/Browser/Internet |
Device key
Save the obnizID and private key.
There are two ways to do this, either by pre-installing it in the device or by writing the settings from the console.
Once set, it cannot be removed or deleted.
Component settings
This specifies where the system components such as LEDs are connected. If it is specified, obnizOS will use it. In the case of obnizOS for each device, the settings are stored in the OS, but if the user sets the settings, obnizOS will use the settings with priority.
Network Settings
These are the settings for connecting to the network and the Internet.
The following information can be saved.
The following information can be saved.
| Network | Max Setting | Settings |
|---|---|---|
| Wi-Fi | 5 | SSID・Password BSSID Static IP Settings Proxy Settings WPA2 Enterprise |
| Wi-Fi MESH (Deprecated) |
5 | MESH ID SSID/Password BSSID Static IP Settings Proxy Settings WPA2 Enterprise |
| Ethernet | 1 | Static IP Settings Proxy Settings |
| 3G/LTE | 1 | APN, ID, Password |
Priority when there is more than one in the same network
The Wi-Fi system allows for multiple connection settings. When multiple profiles are available, it will attempt to connect starting from the most recently saved one.
If the storage limit is reached, the oldest settings will be deleted first. Please note that for Wi-Fi, if you save a new configuration with an existing SSID, it will overwrite the previous one. Multiple profiles cannot be saved under the same SSID.
Primary Network
If there are multiple settings across networks (e.g. Wi-Fi and 3G/LTE), obnizOS will give priority to the last setting.
Settings for devices that are not stored on the device
There are settings that are stored on the cloud side, not on the device, and these can be manipulated by device management or cloud APIs.
(Examples of settings that are not saved on the device)
- Device description
- Access token
- Region settings