Setting from Serial

With the exception of obniz Board series, obniz can be configured with serial communication.


  • Connection TX, RX, GND
  • Baud rate 115200 bps
  • No flow control
  • No parity

Configuration via Serial - Network Selection

In the configuration via serial, the flow is as follows

  • Choose from Wi-Fi, Ethernet and Cellular

  • Wi-Fi:Selection of SSID and password, fixed IP and proxy settings

  • Ethernet:Setting up a connection with your PHY transceiver

  • Cellular:IO, UART and Cellular settings to be used

The first step is to select a network.

-----Select Interface-----

0:Wireless LAN(default)
1:Wired LAN
2:Cellular Module
Input number >> 

Enter 0 for Wi-Fi, 1 for Ethernet, or 2 for Cellular.
If no other default choice is entered within 60 seconds, ESP is restarted.
If the default option is available, it will be assumed that you selected that option. (In the above case, it assumes you have selected Wi-Fi.)

Configuration via Serial - Wi-Fi

If you select Wi-Fi, a nearby Wi-Fi scan will begin and you will be waiting to enter your SSID.

Wi-Fi Scanning...

---Nearby SSID List---
   ID : SSID
- 0 :obniz_wifi
- 1 :AirPortXXX
- 2 :freewifi2g-2019
- 3 : -- Other Network --

Enter SSID-Pass
--- Select SSID Number ---
Input number >>

Type in the ID of the SSID you want to connect to and press Enter. If the SSID you want to connect to is not in the list, click on "Other By selecting "Network", you can connect to SSIDs that are not on the list.

The next step is to set a password.

--- Password ---
Input text >>

With the password, the characters you type will not be displayed. Enter the same characters and press enter to confirm.
Next, configure whether you want to connect to the network using a static IP or DHCP.

--- select Network ---
1:Static IP
Input number >> 

In the case of DHCP, 0 is 1 for a fixed IP. If there is no specification, enter 0.

  • 0 : For DHCP, select whether to configure the proxy next.
  • 1 : If you have a fixed IP address, please refer to this page.

After the settings are made, configure the proxy settings.

--- Proxy Setting ---
0:Proxy disable(default)
1:Proxy enable
Input number >> 0

0 to disable the proxy, 1 to enable it. If you do not specify, enter 0.

  • 0 : If disabled, you can then connect to Wi-Fi.
  • 1 : If enabled, please refer to this page.

After setting up, connect to Wi-Fi.

Wi-Fi Connecting SSID: obniz_wifi

If you are unable to connect, you will be asked to select the SSID again.
When the connection is completed, you will be online.

Connecting Cloud

How to Connect to a Stealth SSID (Private SSID)

Supported since obnizOS 3.2.0
Save it as a stealth SSID and it will actively connect regardless of the Wi-Fi scan results.

Select Other Network from the Wi-Fi scan results.

Wi-Fi Scanning...

---Nearby SSID List--
   ID : SSID
- 0 :obniz_wifi
- 1 :AirPortXXX
- 2 :freewifi2g-2019
- 3 : -- Other Network --

Enter SSID-Pass
Select SSID Number
--- Select SSID Number ---
Input number >>

Other than that, the setup is the same as usual.

below OS3.4.1 It shows configration whether the network we are going to set up is a private SSID or not, so we choose Enable.

--- Hidden SSID ---
- 0:Disable(default)
- 1:Enable
Input number >> 

How to set up a static IP

If you have a static IP, you will be asked a series of questions that are necessary for the setup of a static IP.
To use a static IP, you must fill in all four fields below.

--- IP Address ---
Input address >>
--- Default Gateway ---
Input address >>
--- Subnet Mask ---
Input address >>
--- DNS Address ---
Input address >>

Enter the required value for each and press enter to move on to the next item.

How to configure Proxy

You will need the address and port information of the proxy server to configure the proxy.

--- Proxy Config ---
Proxy Address
Input text >>

--- Proxy Port ---
Port Area:0-65535
Input number >> 8080

Enter the required value for each and press enter to move on to the next item.

Configuration via Serial - Ethernet

In case of wired LAN, you will be asked to set up a connection with your PHY transceiver, and the necessary settings are in the following order.

--- Phy Base Address ---

The base address of the PHY transceiver. Enter the value of the transceiver to which it is connected.

0 or 1 for the LAN8720.
For the TLK110, it is 31.

--- Clock Mode ---
0:IO0 IN
2:IO16 OUT
3:IO17 OUT

How to synchronize the PHY transceiver with the ESP32

Setting Description
IO0 IN GPIO0 become clock input
IO0 OUT GPIO0 become 50Mhz clock output from internal APLL
IO16 OUT GPIO16 become 50Mhz clock output from internal APLL
IO17 OUT GPIO17 become 50Mhz reversed clock output from internal APLL
--- Power Mode ---
0-40:GPIO reset + module reset
41:only module reset:

This is how to reset the PHY transceiver from the ESP side.

Setting Description
0-40 specified GPIO will output reset
41 just module reset.
--- MDC GPIO ---

Enter the number of the GPIO used to connect the PHY transceiver to the MDC.

--- MDIO GPIO ---

Enter the number of the GPIO used to connect the PHY transceiver to the MDIO.

--- CHIP ---

Select the PHY transceiver.

When the settings are completed, a confirmation screen will appear as shown below, and the entered values will be displayed again and saved.

---Check Data---
ClockMode : 3
PowerMode : 5
CHIP : 0


It becomes active as soon as it is saved and attempts to connect to the cloud at all times.

You will be online when the connection is complete.

Connecting Cloud

Configuration via Serial - Cellular

The procedure for setting up serial communication is as follows

  1. Selecting which module to communicate with
  2. Enter the required information for each.

First, select a module.

--- Cellular Module ---
1:SARA-U201(Switch Science M5Stack 3G)
Input number >> 

Enter 0 for BG96 or 1 for SARA-U2.

Enter the IO settings used in each module.

The following example illustrates BG96 with reference to the "DevKitC" introduced in the Connection Method section.

--- BG96 Config ---
--- Power GPIO ---
Input number >> 14
--- Reset GPIO ---
Input number >> 15

Next, configure which Uart is to be used.

--- Uart Index ---
Input number >> 1
--- Uart RX ---
Input number >> 12
--- Uart TX ---
Input number >> 13
--- Uart CTS ---
other:no use
Input number >> 41
--- Uart RTS ---
other:no use
Input number >> 41
--- Uart Band Rate ---
Input number >> 4

Finally, enter the settings required to connect to the Cellular network. As APN, ID, and password may vary depending on your carrier and contract, please make sure to check the setting items for each. Please refer to the websites and contracts of the companies.

As an example, here are the values set by Y!mobile as a reference.

--- Cellular APN ---
Input text >>
--- Cellular ID ---
Input text >> ym
--- Cellular Password ---
Input text >> ym

You are now set up.

Resetting the settings

Only for a short period of time (about 0.5 seconds) when starting up or when the connection to the Internet is not working Waiting to go to the setting screen.

Press 's' to setting mode: s

You can enter the setting screen by typing "s" in this state.

-----Select Setting-----

1:Interface(Wireless LAN or Wired LAN)
2:All Reset
3:Wireless LAN Reset
4:Wired LAN Reset: 

Select the desired setting from the list and enter a number.




You will return from the setting screen and enter the normal mode.


Switch between Wi-Fi and Ethenert


Reset all settings except for the device key


Reset your Wi-Fi settings.


Reset the Ethernet settings.

Depending on the setting, a confirmation screen may appear as follows

-----All Reset (WirelessLAN and WiredLAN setting delete)-----