obniz Docs Reference obnizOS CHANGELOG

CHANGELOG

5.0.1

2024/07/17

Target OS

  • obnizOS for obniz BLE/Wi-Fi Gateway Gen 2.0 ( hw=blewifi_gw2 )
  • obnizOS for obniz BLE/LTE Gateway (Cat.4) ( hw=blelte_gw2 )
  • obnizOS for AK-030 LTE Cat.M1 USB Dongle ( hw=ak030 )
  • obnizOS for obniz BLE/Wi-Fi Gateway ( hw=encored )
  • obnizOS for IoTBank USB Gateway ( hw=iotbankusbgw )
  • obnizOS for M5Stack Basic ( hw=m5stack_basic )
  • obnizOS for ESP32 ( hw=esp32w or hw=esp32p )
  • obnizOS for obnizPLC ( hw=plc )
  • obnizOS for ESP32C3 ( hw=esp32c3 ) (when using obniz Now)

Internet Connection

Common Changes

  • Faster recovery after disconnection from the cloud
  • On-premises and dedicated cloud connection function (when using obniz Now)

Wi-Fi

  • Support for WPA3
  • Continuous update of RSSI values viewable in the cloud
  • Security measures: CVE-2019-9496, CVE-2022-23304, CVE-2022-23303, CVE-2019-9494, CVE-2017-13077, CVE-2017-13078, CVE-2017-13079, CVE-2017-13080, CVE-2017-13081, CVE-2017-13082, CVE-2020-26142, CVE-2023-52160

Ethernet

  • Support for W5500 modem (HTTP/HTTPS) (when using obniz Now)

4G/LTE

  • Standard support for nRF9160 (when using obniz Now)
  • Improved communication speed for all modems

Settings

  • Added mode to prevent automatic transition to setup mode after connection failure (when using obniz Now)
  • Added full stop function for the serial console (when using obniz Now)

Peripherals

  • Improved Bluetooth connection stability

System

  • OTA progress can be viewed in the cloud
  • Fixed issue where OTA would fail if the app was installed

Hardware

  • Allowed use of the same SPI line as the display on M5Stack Basic
  • Ensured cloud connection is possible even when the main switch is faulty and unable to enter the setup screen

4.2.1

Available OS

  • obnizOS for obniz BLE/Wi-Fi Gateway Gen 2.0 ( hw=blewifi_gw2 )
  • obnizOS for AK-030 LTE Cat.M1 USB Dongle ( hw=ak030 )

On-premise support

  • Supported the on-premise enviroment. (ex. wifi network is available but can’t connect to obnizCloud.)

Network connection

  • Fixed a bug that take a long time to reconnect after online then disconnect from network.
  • Corrected text that is displayed browser setting and E-ink display.

BLE

  • Fixed a bug that could cause offline for up to 10 min when device is reconnect to obnizCloud
  • Fixed a bug where reconnecting to obnizCloud would cause error about BLE to occur and then offline for up to 10 min.

System

  • Fixed potential minor bugs.

4.1.1

2022/11/20

Available OS

  • obnizOS for obniz BLE/Wi-Fi Gateway Gen 2.0 ( hw=blewifi_gw2 )
  • obnizOS for obniz BLE/LTE Gateway(Cat.4) ( hw=blelte_gw2 )
  • obnizOS for AK-030 LTE Cat.M1 USB Dongle ( hw=ak030 )

BLE

  • Resolved issue with device freezing when API connection is lost during BLE scan

4.1.0

2022/9/28

Available OS

  • obnizOS for obniz BLE/Wi-Fi Gateway Gen 2.0 ( hw=blewifi_gw2 )
  • obnizOS for obniz BLE/LTE Gateway(Cat.4) ( hw=blelte_gw2 )
  • obnizOS for AK-030 LTE Cat.M1 USB Dongle ( hw=ak030 )
  • Added the ability to enter setting mode at any time with a long press of the button after startup
    Long press timeout 7 seconds, long press beyond the timeout will disable the button and go back to the original operation, and re-enable it by releasing the button.
    (e.g., if you are online, it will return to online)
  • Support for obniz BLE/LTE Gateway (Cat.4) browser setting screen

Network Connection (LTE)

  • Correction of the phenomenon that AK-030 may keep rebooting due to short communication timeout period when connected to LTE.
  • Correction of communication command format with LTE modem
  • Modification of request format to cloud when connecting to LTE
  • Added "Wake up" status to the status before connection
  • Fixed the phenomenon that AK-030 reboots with communication error in slow communication speed environment after network connection.
  • Supported SIM setting that does not require id/password

BLE

  • Support scan filter for extended advertising and periodic advertising on BLE devices.

Network settings (CUI settings screen)

  • Improved usability by presetting hardware settings for each device and omitting settings.

Network settings (Browser settings)

  • Improved stability on android and windows
  • Disabled double operation of connect button to prevent malfunction
  • Fixed a bug that no-communication timeout did not work when opening the browser settings screen
  • Extended restart timeout from 20 seconds to 30 seconds when there is more than one network setting

System

  • Fixed to enable port listen for local connect only when necessary
  • Fixed to connect with WiFi set by WPS when WPS succeeds on a device with cellular settings saved.
  • Fixed crash and restart after 10 minutes of no connection.
  • Updated no-communication timeout when disconnected from the cloud from 1.5 minutes to 10 minutes

Known Issues

  • The device with Wi-Fi MESH settings is not going online

4.0.0

2022/08/01

Available OS

  • obnizOS for obniz BLE/Wi-Fi Gateway Gen 2.0 ( hw=blewifi_gw2 )
  • Support for obniz BLE/Wi-Fi Gateway Gen 2.0 browser setting screen
  • When Wi-Fi setting by WPS is failed, it changes to the setting mode.

BLE

  • BLE 5.0 support

Extended Advertising and Periodic Advertising do not support scan filter

Added API

  • Added API to manipulate the display
  • API to change ping interval between device and cloud added
  • Added API for acquiring information on the currently connected Wi-Fi
  • Add API to operate tcp data cache

obniz BLE/Wi-Fi Gateway Gen 2.0 Details

In normal mode, the following items are displayed on the screen

  • QR code for device registration (used for linking to an account)
  • SSID of the connected Wi-Fi
  • Version of obnizOS
  • Device connection status

In setting mode, the following items are displayed on the screen

  • QR code for device registration (used for linking to account)
  • Setup procedure via browser

3.5.0

2021/07/21

Available OS

  • obnizOS for obniz Board ( hw=obnizb1 )
  • obnizOS for obniz Board 1Y ( hw=obnizb2 )
  • obnizOS for obniz BLE/Wi-Fi Gateway ( hw=encored )
  • obnizOS for CONNECT HUB Cellular Model ( hw=encored_lte )
  • obnizOS for BLE Stick ( hw=ble_stick )
  • obnizOS for M5StickC ( hw=m5stickc )
  • obnizOS for M5Stack Basic ( hw=m5stack_basic )
  • obnizOS for ATOM Lite ( hw=m5atom_lite )
  • obnizOS for obnizPLC ( hw=plc )
  • obnizOS for ESP32 ( hw=esp32w or hw=esp32p )

Internet Connectivity

Commonly Changed Points

  • Network Failover now available for all connectivity. If one tried (ex Wi-Fi) and failed, then next setting will betried (ex cellular)
  • obnizOS now connect to obniz.com not obniz.io initiallly.

Wi-Fi

  • WPA2 Enterprise Support (Only username, pass, anonymous id authentication)
  • BSSID option now available to fix Wi-Fi AP connect to.
  • Startup Wi-Fi scan nerver performed when no Wi-Fi Setting Found
  • Stop reducing Wi-Fi tx power when reboot after BOR.
  • Fix Wi-Fi connection tried from old setting. now tried from latest one.

Wi-Fi MESH

  • Newly Supported Wi-Fi MESH

Obniz device now create MESH network automatically to connect to the internet even if some devices can't reach to an access point.

This feature require subscribing Wi-Fi MESH plan on obnizCloud.

Cellular

  • Starting BG96 Modem Standard Support
  • Starting AK030 Modem Standard Support
  • SARA_U2 Experimental Implementation

Setting

Setting via Serial

  • Typing menu let you enter setting mode anytime.
  • Now support devices which wired ESP32 console Rx and Tx.
  • Drop supporting typing s to enter setting mode on startup.
  • Drop supporting deleting each network setting. only all delete available.
  • Drop supporting hardware wiring information setting as CLI.
  • Now accept raw setting from serial

Setting via Wi-Fi

  • Passkey is now required (default obniz).
  • Captive Portal Support. you see the browser automatically when you connect to your obniz device.
  • The IP of the device has been changed from 192.168.0.1 to 192.168.254.1.
  • Startup setting (pressing button on startup) and Wi-Fi configration now merged. You can choose from menu on browser.
  • Drop supporting deleting each network setting. only all delete available.
  • Drop supporting hardware wiring information setting.
  • Wi-Fi and Cellular configration now let you see progress and failing results on your screen. and you can retry when failed without rebooting device.
  • All network configration saves your configration at first regardless success or not.
  • Connection timeout is longer (2 minutes) when your device has no network configration compared from others (20 seconds)
  • Wi-Fi now scans everytime user open/reload the Wi-Fi setting page.
  • MacAddress and MESH ID are now checked for input
  • The password field is now hidden by the password attribute.
  • No longer restarts when deleting settings

Settings via display

  • Network settings deletion is now a function to delete all network settings, not just Wi-Fi.

etc

  • Factory Reset has been removed.
  • WPS Mode supported. Hold pressing over 3 time while setting mode. The device will enter WPS mode. If succeed, the device save Wi-Fi setting and restart.
  • Now can accept setting from obniz's Android app
  • Circuit information can be configured

System

  • Startup time faster around 1.5 seconds compared from before.

Hardware

  • Dynamic circuit setting now available.

You can let your device know and use below components

  • Seithces
  • LEDs (power or status)
  • Ethernet PHY
  • 3G/LTE Modem

When you configured, then obnizOS will recognize and use it.

Peripheral

speakers

  • fix In M5Stack, the speaker IO is now free from being occupied by obnizOS.

BLE

  • Internal memory management improved. Better stability for heavy usage while scanning.

3.4.5

2021/02/26

Available OS

  • obnizOS for obniz Board ( hw=obnizb1 )
  • obnizOS for obniz Board 1Y ( hw=obnizb2 )
  • obnizOS for obniz BLE/Wi-Fi Gateway ( hw=encored )
  • obnizOS for CONNECT HUB Cellular Model ( hw=encored_lte )
  • obnizOS for BLE Stick ( hw=ble_stick )
  • obnizOS for M5StickC ( hw=m5stickc )
  • obnizOS for M5Stack Basic ( hw=m5stack_basic )
  • obnizOS for ATOM Lite ( hw=m5atom_lite )
  • obnizOS for ESP32 ( hw=esp32w or hw=esp32p )

Wi-Fi

  • fix Wi-Fiスッキャンで14chが対象だったのを追加
  • Wi-Fi接続成功率の向上

BLE

  • Improve Wi-Fiが弱い環境でのBLEスキャンにおけるクラッシュ率の改善

System

  • Factory Resetによる内部メモリのクリーンアップ
  • Factory Reset が次のhwで利用可能となります hw=encored, encored_lte
  • 起動時オプション用のボタンを起動時長押しすることで(10sec以上) FactoryResetの実施 for hw=encored, encored_lte, ble_stick, atom_lite

Peripheral

  • 起動時オプション用のボタンが obniz.switch として利用可能に、またクラウド実行のきっかけとして利用可能。対象hw=encored, encored_lte, ble_stick, atom_lite

3.4.4

2021/01/24

Available OS

  • obnizOS for obniz Board ( hw=obnizb1 )
  • obnizOS for obniz Board 1Y ( hw=obnizb2 )
  • obnizOS for obniz BLE/Wi-Fi Gateway ( hw=encored )
  • obnizOS for CONNECT HUB Cellular Model ( hw=encored_lte )
  • obnizOS for BLE Stick ( hw=ble_stick )
  • obnizOS for M5StickC ( hw=m5stickc )
  • obnizOS for M5Stack Basic ( hw=m5stack_basic )
  • obnizOS for ATOM Lite ( hw=m5atom_lite )
  • obnizOS for ESP32 ( hw=esp32w or hw=esp32p )

Wi-Fi

Improves

  • Improve reconnection time after disconnection when Wi-Fi Access point was missed at scanned time.
  • Improve hang monitoring more fast detection.
  • Improve stop rebooting when Wi-Fi lost.

Network

Bug Fixes

  • Fix Failed to connect static IP on some cases.

BLE

Bug Fixes

  • Fix Crash occures when under heavy communication.

3.4.3

2020/11/20

Available OS

  • obnizOS for obniz Board ( hw=obnizb1 )
  • obnizOS for obniz Board 1Y ( hw=obnizb2 )
  • obnizOS for obniz BLE/Wi-Fi Gateway ( hw=encored )
  • obnizOS for CONNECT HUB Cellular Model ( hw=encored_lte )
  • obnizOS for BLE Stick ( hw=ble_stick )
  • obnizOS for M5StickC ( hw=m5stickc )
  • obnizOS for M5Stack Basic ( hw=m5stack_basic )
  • obnizOS for ATOM Lite ( hw=m5atom_lite )
  • obnizOS for ESP32 ( hw=esp32w or hw=esp32p )

Hardwares

New OS for Hardwares

  • obnizOS for CONNECT HUB Cellular Model
  • obnizOS for BLE Stick
  • obnizOS for ATOM Lite

Wi-Fi

Improves

  • Connection success rate.
  • Change Connection LED Status for representing more accurate state.
  • Security fix: Fixed AP switch to adjacent channel without disconnect (CVE-2020-12638)
  • Reduce time until wifi setting when some SSID/Passwords stored in a device.
  • Hide showing connection error while first trying.
  • Store SSID/Password from Setting via Browser when SSID specified.

Bug Fixes

  • Fix Setting via Browser never accept SSID and password space character.
  • Fix Status LED suddenly stop(red or blank) when connected sation removed from obniz Wi-Fi.
  • Fix reboot when no SSID found

BLE

Improves

  • Improve Communication Speed.

Bug Fixes

  • Fix Crash occures when under heavy communication.

Cloud

Bug Fixes

  • Fix Fails authentication rarely.

Peripheral

Improves

  • block spi1 use for M5StickC/ATOM Lite

3.4.2

2020/09/01

Available OS

  • obnizOS for obniz Board
  • obnizOS for obniz Board 1Y
  • obnizOS for obniz BLE/Wi-Fi Gateway
  • obnizOS for M5StickC
  • obnizOS for M5Stack Basic
  • obnizOS for ESP32

Improves.

  • obniz BLE/Wi-Fi Gateway status LED color change
    • At OTA Red blinking → Blue fast blinking
    • At the time of web setting: Green blinking → Purple blinking
  • Heat reduction function was set again. It works more when not using bluetooth.
  • Wi-Fi, Ethernet Mac Address reporting

Wi-Fi

  • Wi-Fi Connection strategy was changed.
  • Hidden SSID setting was removed. All Wi-Fi treat as hidden Wi-Fi.

Bug Fixes.

  • Fix Invalid LED(RED Keeps) for obniz BLE/Wi-Fi Gateway.
  • Fixed a bug in the plugin command transmission function.
  • plugin onlineFlg bug fixed.

3.4.1

2020/08/18

Available OS

  • obnizOS for obniz BLE/Wi-Fi Gateway

"obnizOS for obniz BLE/Wi-Fi Gateway" below 3.4.1 will be automatically OTA to 3.4.1.

Improves

  • Changed Wi-Fi connection method. (hidden SSID setting is removed)

Bug Fixes

  • Resolves an issue where the OS would not boot on Gateway under certain conditions.

3.4.0

Available OS

  • Plugin OS

2020/07/22

Added

  • Plug-in Functionality

Bug Fixes.

  • Improved Wi-Fi connection stability
  • M5Stack Display Reversal Support
  • Improved ADC accuracy
  • Correcting a typo in the settings screen.

3.3.0

2020/07/01

Added

  • Wi-Fi Access Point Information can see on obniz Cloud.

Bug Fixes

  • Wi-Fi stability improvement
  • BLE scan device side filtering fails sometime.
  • obniz Board 1Y password typing timeout so early.

3.2.1

2020/5/28

Network

  • Update TLS certification

3.2.0

2020/03/16

  • obnizOS for obniz Board
  • obnizOS for obniz Board 1Y
  • obnizOS for obniz BLE/Wi-Fi Gateway
  • obnizOS for ESP32

Display
ADD: Color display Support for obniz.display command. This is only for future devices.
BLE
ADD: BLE scan target filter on device side to reduce data transfer
  Fix: Sometimes stop ble module on ble first initialize.
Wi-Fi
ADD: Hidden SSID setting and connectivity
ADD: Device Setting Mode for obniz BLE/Wi-Fi Gateway
ADD: LED show device status for obniz BLE/Wi-Fi Gateway
  Fix: Cannot input symbol on Wi-Fi password when using advance mode.
  Fix: Unstable communication with obniz cloud at TLS/SSL.
  Fix: Unstable behavior when using local connect.

3.1.0

2020/01/16

  • obnizOS for obniz Board
  • obnizOS for obniz Board 1Y
  • obnizOS for obniz BLE/Wi-Fi Gateway
  • obnizOS for ESP32

Added

  • HTTP/HTTPS Proxy setting via softAP Wi-Fi configration
  • TLS communication for business plan

Improves

  • Add Back slash for text inputs on obnizOS first setup.
  • Changed softAP Wi-Fi setting ip address from 1.2.3.4 to 192.168.0.1
  • Add one more system halt handler to keep obnizOS connected to the Cloud.

Bug Fixes

  • fix Too much delay or timeout of 1.2.3.4 access on softAP Wi-Fi setting(this happen only for obnizOS for ESP32 or Encored IoT Hub)
  • fix unstable behavior when local connect enabled.
  • fix unstable behavior after wait() called.

3.0.2

  • obnizOS for obniz Board
  • obnizOS for obniz Board 1Y
  • obnizOS for obniz BLE/Wi-Fi Gateway
  • obnizOS for ESP32

Breaking Changes

  • Old Ble commands from obniz.js(1.X.X and 2.X.X)/python(0.5.1 and early) can’t be accepted.
  • Websocket/REST API now only accept HCI BLE commands for obnizOS3 series

Added

  • add Hardware Support: obniz Board 1Y/ Encored IoT Hub
  • add Sleep function for obniz Board 1Y
  • add Bluetooth HCI command

Improvements

  • change first setup display UI for obniz Board series.
  • change error UI more readable.
  • change Minimum Network Latency from 10msec to 1msec when local connect enabled. It makes better
  • performance for robot controlling.

Bug Fix

  • fix obnizOS disconnect from obniz cloud when wait() called with over 30min.

2.1.1

  • obnizOS for ESP32

Improvements

  • BLE connection

2.1.0

  • obnizOS for obniz Board
  • obnizOS for ESP32

Added

  • Ethernet Mode
  • Works with ESP32-PICO-D4
  • Wi-Fi Configration via Wi-Fi.
  • Static IP
  • TCP Command
  • Reset setting from serial

Improvements

  • I2C Clock Stretching accept more longer time.

Bug Fix

  • Cloud connection to obniz cloud fails in some case.

2.0.2

  • obnizOS for ESP32

BugFix

  • change i2c clock stretch time to longer
  • Fix GPIO32-39 input data

2.0.1

  • obnizOS for obniz Board

Fixed

  • fixed reboot or hang when network state is going invalid
  • fixed invalid treatment for continuers websocket frame.

2.0.0

  • obnizOS for obniz Board

Added

  • io.animation now accept repeat and finished notification.

Changed

  • ad result is more accurate and voltage correction only works vcc under 4.5v

1.0.13

  • obnizOS for obniz Board

1.0.12

  • obnizOS for obniz Board

Fixed

  • BLE peripheral connection failed

1.0.11

  • obnizOS for obniz Board

Fixed

  • UART RTS, CTS not worked

1.0.10

  • obnizOS for obniz Board

Fixed

  • Fix BLE connection error

1.0.9

  • obnizOS for obniz Board

Fixed

  • UART/SPI/I2C/PWM stability improvement on huge data
  • BLE connection error during scan

1.0.8

  • obnizOS for obniz Board

Added

  • Display firmware version and mac address

1.0.7

  • obnizOS for obniz Board

Fixed

  • Lost error messages from obniz when after special sequences

1.0.6

  • obnizOS for obniz Board

Added

  • Show cloud connection fail reasons on OLED.

Fixed

  • crash when two or more io.animation registrated
  • Wifi/Bluetooth Stability fix and Improvements

1.0.5

  • obnizOS for obniz Board

Fix

  • fix shutdown bug when ble read/write unknown characteristics/descriptor

1.0.4

  • obnizOS for obniz Board

Changed

  • Better noise treatment of switching 5v/3v on each IO.

Fix

  • Few Wi-Fi Bugs

1.0.3

  • obnizOS for obniz Board

Add

  • SPI write max length expands. 32 byte to 1024 bytes

1.0.2

  • obnizOS for obniz Board

Fix

  • Wifi Password can't select some characters like '@'

1.0.1

  • obnizOS for obniz Board

Fix

  • Wifi Password can't select 'X'

v1.0.0

First Release