11 stable releases

2.1.5 Oct 17, 2024
2.1.4 Mar 8, 2024
2.1.3 Jun 8, 2022
2.1.0 Jan 18, 2022
2.0.3 Jun 8, 2021

#39 in Hardware support

Download history 31/week @ 2024-07-29 48/week @ 2024-09-23 8/week @ 2024-09-30 154/week @ 2024-10-14 16/week @ 2024-10-21

179 downloads per month
Used in updatehub-cloud-sdk

Apache-2.0

35KB
955 lines

FOSSA Status Coverage Status

Platform Build Status
Linux - x86_64 build status
Linux - AArch64 build status
Linux - ARMv7 build status

UpdateHub is an enterprise-grade solution which makes simple to remotely update all your embedded devices in the field. It handles all aspects related to sending Firmware Over-the-Air (FOTA) updates with maximum security and efficiency, making your project the center of your attention.

This repository provides the UpdateHub agent for Embedded and Industrial Linux-based devices.

Getting started

To start using UpdateHub, it is suggested that you follow the Getting started guide in the UpdateHub documentation.

Features

The support provided by the UpdateHub for the device includes:

  • Bootloader upgrade support (U-Boot and GRUB)
  • Flash support (NAND, NOR)
  • UBIFS support
  • Update package signature validation for security
  • Automated rollback in case of update fail
  • Conditional installation (content, version and custom pattern support)
  • Callback support for every update step
  • HTTP API to control and inquiry the local agent

To learn more about UpdateHub, check out our documentation.

Building and testing

The UpdateHub agent is developed using Rust programing language due its focus in safety and system level integration. In case you wish to build it, you can:

cargo build --release

Some tests are marked as ignored because they require user previleges. There's a Vagrant file that can be used to run them. To run tests on the virtual machine run:

vagrant up
vagrant ssh

and inside the SSH session, run:

sudo -i
cd /vagrant
cargo test
cargo test -- --ignored

License

Licensed under Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0).

Contributing

UpdateHub is an open source project and we love to receive contributions from our community. If you would like to contribute, please read our contributing guide.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.4–1MB
~22K SLoC