https://github.com/mongoose-os-libs/rpc-service-ota

https://github.com/mongoose-os-libs/rpc-service-ota

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mongoose-os-libs/rpc-service-ota
• Owner: mongoose-os-libs
• License: other
• Created: 2017-06-07T09:57:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-15T00:18:28.000Z (almost 3 years ago)
• Last Synced: 2024-07-31T21:51:59.844Z (4 months ago)
• Language: C
• Size: 440 KB
• Stars: 7
• Watchers: 7
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mongoose-os - rpc-service-ota

README

        
# RPC Service - OTA (Over The Air updates)

This service provides an ability to manage OTA on devices remotely.

It is possible to call this service programmatically via serial, HTTP/RESTful,

Websocket, MQTT or other transports

(see [RPC section](/docs/mongoose-os/userguide/rpc.md)) or via the `mos` tool.

See in-depth description of our OTA mechanism at

[Updating firmware reliably - embedded.com](http://www.embedded.com/design/prototyping-and-development/4443082/Updating-firmware-reliably).

See OTA video tutorial:

Below is a list of exported RPC methods and arguments:

## OTA.Update

Trigger OTA firmware update. Arguments:

```javascript

{

  "url": "https://foo.com/fw123.zip", // Required. URL to the new firmware.

  "commit_timeout": "300"             // Optional. Time frame in seconds to do

                                      // OTA.Commit after reboot. If commit is

                                      // not done during the timeout, OTA rolls back.

}

```

A new firmware gets downloaded to the separate flash partition,

and is marked dirty. When the download is complete, device is rebooted.

After reboot, a firmware partition could become committed by calling

`OTA.Commit` - in which case, it is marked as "good". Otherwise, a device

reboots back into the old firmware after the `commit_timeout` seconds.

Example usage:

mos call OTA.Update '{"url": "http://1.2.3.4/fw.zip", "commit_timeout": 300}'


## OTA.Commit

Commit current firmware. Arguments: none.

Example usage:

mos call OTA.Commit


## OTA.Revert

Rolls back to the previous firmware. Arguments: none.

Example usage:

mos call OTA.Revert


## OTA.CreateSnapshot

Create new firmware patition with the copy of currently running firmware. Arguments:

```javascript

{

  // Optional. If true, then current firmware is uncommited, and needs to

  // be explicitly commited after the first reboot. Otherwise, it'll reboot

  // into the created snapshot. This option is useful if a dangerous, risky

  // live update is to be done on the living device. Then, if the update

  // fails and device bricks, it'll revert to the created good snapshot.

  "set_as_revert": false,

  // Optional. Same meaning as for OTA.Update

  "commit_timeout": "300"

}

```

Example usage:

mos call OTA.CreateSnapshot


## OTA.GetBootState

Get current boot state. Arguments: none.

Example usage:

mos call OTA.GetBootState

{

  "active_slot": 0,       # Currently active flash partition.

  "is_committed": true,   # Current firmware is marked as "good" (committed).

  "revert_slot": 0,       # If uncommitted, slot to roll back to.

  "commit_timeout": 0     # Commit timeout.

}


## OTA.SetBootState

Get current boot state. Arguments: see `OTA.GetBootState` reply section.

Example usage:

mos call OTA.SetBootState '{"revert_slot": 1}'