Skip to main content

cli tool for obnizOS setup

Project description


obniz_cli is cli tool for obnizOS(for ESP32) install.


Using pip,

pip install obniz_cli


Connect the ESP32 device from the serial port to your PC and check if the PC recognizes the device. The following command shows the list of devices.

python -m

(You can execute this command after pip install obniz_cli.)
In most cases, port name is dev/cu.SLAB_USBtoUART or like COM3. If you can't find these port or can find but fail to install, you may need USB-driver for devices from here.



obniz_cli flashos [-b] [-p]

You can install obnizOS to your ESP32 device. If you execute without -p option, it is displayed as follows:

0: /dev/cu.Bluetooth-Incoming-Port
1: /dev/cu.SLAB_USBtoUART

Select NUMBER from above list(or if you want to cancel, input N key):

Select the device you want to install. (A device port can be passed to command with -p option like obniz_cli flashos -p /dev/cu.SLAB_USBtoUART).

Then, latest obnizOS is downloaded and installed to device. By default, installation is performed at 115200bps but if installation failed, try to decrease it by obniz_cli flashos -b 115200.

After install, cli automatically change serial mode to set obnizOS configuration


obniz_cli eraseos [-p]

You can reset your device by this command.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obniz_cli-0.0.5.tar.gz (3.5 kB view hashes)

Uploaded Source

Built Distribution

obniz_cli-0.0.5-py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page