Giter Club home page Giter Club logo

yaota8266's Introduction

yaota8266

yaota8266 is yet another bootloader/over-the-air (OTA) update solution for ESP8266 WiFi SoC. Unlike many other solutions, yaota8266 does not require reserving FlashROM space of 2x the size of the firmware. Instead, it updates the firmware in-place. Of course, this means that if an OTA update fails, there's no previous firmware to fallback to. On the other hand, if OTA update fails, you likely will repeat it again, until it succeeds. So, for many usecases the process of OTA update will be the same - a user will just repeat it until it succeeds, regardless whether there's a fallback firmware or not.

yaota8266 is written with big firmware and small flash sizes in mind. For example, it enables OTA updating for full-fledged MicroPython (firmware sizes of 512+ KB) on 1MB flash devices, and still have a small, but usable filesystem.

Structure and algorithm

yaota8266 consists of two parts:

  • 2nd-stage bootloader boot8266
  • ota-server application

boot8266 works in the following way:

  1. 1st-stage bootloader in ESP8266 BootROM loads boot8266 (from sector 0). It is small and fits within a single FlashROM sector (4K).
  2. boot8266 checks whether an OTA button on device is pressed. If it is, it goes in OTA mode.
  3. If the button is not pressed, it verifies a checksum of a user application. If it fails (for example, because of unsuccessful, partial previous firmware update), it goes into OTA mode.
  4. If OTA mode is requested, boot8266 loads an application starting at the sector 1. This is intended to be the ota-server, but from boot8266's point of view, it's just a standard ESP8266 application, which it loads recursively in the same (or very similar) way that the BootROM does.
  5. If OTA mode was not requested, boot8266 loads a user application which lies beyond the ota-server application end (offset is configurable). The above note applies here as well - boot8266 loads an application in the same way, and doesn't care what it does. (but boot8266 has partially hardcoded knowledge about sizes of these applications, and verifies checksum of only the second one).

ota-server works in the following way:

  1. Starts a UDP server on port 8266.
  2. Expects consecutive UDP datagram containing chunks of new firmware.
  3. Each datagram is signed with RSA private key. Only someone with a valid private key may produce valid datagrams, information from which ota-server will flash as a user application. (The public key is configured when building ota-server.)
  4. ota-client host-side application is provided to drive OTA upgrade process for a device in OTA mode.

Build and run for dummy

For build you need type:

  • make

It will do the following:

  • create "config.h" from "config.h.example", you can edit if you want
  • generate priv.key, pub.key (and pubkey.h), please save priv.key, if you lose it, you cannot update firmware over OTA
  • build boot8266
  • build ota-server (OTA firmware application)
  • generate yaota8266.bin

For deploy you need:

  • install esptool.py (programmer for ESP board)
  • plugin you board (to the usb or uart port)
  • type 'make deploy'

It will write firmware to ESP board. ESP save last wifi configuration. If you start ota-server, the ESP load last configuration. If you don't know how ESP config wifi, you may load firmware-ota by UART first time, and set configuration. Next time, after ota-server start it load it config.

For write firmware-ota by manual (example from micropython in the project "micropython"):

  • cd ports/esp8266
  • make
  • make ota
  • esptool.py write_flash 0x3c000 build/firmware-ota.bin

Known issues

yaota8266 is a work in progress and is not yet fully functional per the specs above.

yaota8266's People

Contributors

basm avatar pfalcon avatar schinckel avatar ulno avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

fizista

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.