Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/drogue-iot/embedded-update

Last synced: 29 days ago
JSON representation

Host: GitHub
URL: https://github.com/drogue-iot/embedded-update
Owner: drogue-iot
License: apache-2.0
Created: 2022-06-01T14:20:48.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-10-06T08:35:20.000Z (about 1 year ago)
Last Synced: 2024-10-26T23:10:29.936Z (about 2 months ago)
Language: Rust
Size: 108 KB
Stars: 20
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

rust-embedded - embedded-update
awesome-embedded-rust - embedded-update

README

# Firmware updates for embedded devices

[![CI](https://github.com/drogue-iot/embedded-update/actions/workflows/ci.yaml/badge.svg)](https://github.com/drogue-iot/embedded-update/actions/workflows/ci.yaml)
[![crates.io](https://img.shields.io/crates/v/embedded-update.svg)](https://crates.io/crates/embedded-update)
[![docs.rs](https://docs.rs/embedded-update/badge.svg)](https://docs.rs/embedded-update)
[![Matrix](https://img.shields.io/matrix/drogue-iot:matrix.org)](https://matrix.to/#/#drogue-iot:matrix.org)

The `embedded-update` crate implements firmware update protocol for embedded devices connected to a firmware update service, which works in `no_std` environments.

Both the device to be updated and the update service are pluggable, so the protocol can be used with any device flash or service that implements the provided traits. This means you can use the library directly on an embedded device, or on a gateway that proxies requests across multiple devices.

The library provides the `InMemory` and `Serial` reference implementations of the `UpdateService` trait, and the `Simulator` and `Serial` implementations for the `FirmwareDevice` trait.

Update service and device implementations can be added to `embedded-update` when types and traits for interacting with device flash and network connections are more widely available.

## Supported update services

* (builtin) `Serial` - implements a serial update protocol for a device, that can be used over UART, USB Serial etc.
* (builtin) `InMemory` - implements a hard coded update service that serves an update from memory.
* (external) [Drogue Device `HttpUpdater`](https://github.com/drogue-iot/drogue-device) - implements an update protocol over HTTP using Drogue Cloud + Drogue Ajour.
* (external) [Drogue Device `LorawanService`](https://github.com/drogue-iot/drogue-device) - implements an update protocol over LoRaWAN using Drogue Cloud + Drogue Ajour.

## Supported devices

* (builtin) `Serial` - implements a serial update protocol allowing to talk to a device implementing this protocol over UART, USB Serial etc.
* (builtin) `Simulated` - implements a simulated device for testing update services.

# Minimum supported Rust version (MSRV)

`embedded-update` requires a feature from `nightly` to compile when using the `nightly` flag.

* async_fn_in_traits