https://github.com/bytebeamio/bytebeam-esp-rs-sdk

SDK for connecting ESP with Bytebeam IoT platform using Rust
https://github.com/bytebeamio/bytebeam-esp-rs-sdk

Last synced: 8 months ago
JSON representation

SDK for connecting ESP with Bytebeam IoT platform using Rust

• Host: GitHub
• URL: https://github.com/bytebeamio/bytebeam-esp-rs-sdk
• Owner: bytebeamio
• License: mit
• Created: 2023-01-27T07:42:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-14T15:14:23.000Z (about 3 years ago)
• Last Synced: 2025-01-31T04:51:29.638Z (over 1 year ago)
• Language: Rust
• Size: 43.9 KB
• Stars: 22
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    bytebeam-esp-rs-sdk 





  Connect ESP32 with Bytebeam IoT platform using Rust 🦀








  

  

    

  

  

  

    

  

  

  

    

  

  

  

  

  

  

  

  

  

    

  





  Built with ❤︎ by

  Bytebeam










  Check out 

  docs to get started

  






Bytebeam is one stop IoT backend which let's you manage OTA updates, analytics, device-mobile communication & much more :sparkles: so that you can take your project to next level without hassel.

The **bytebeam-esp-rs-sdk** allows you to connect your ESP32 board with Bytebeam using **Rust** 🦀 . You can use any ESP32 board, we used ESP32-DevkitV1 board for testing and it worked like charm! Want to try it out? see the [examples](https://github.com/bytebeamio/bytebeam-esp-rs-sdk/blob/main/examples).

> **IMPORTANT** : `bytebeam-esp-rs` requires that the certificates file ( provided by Bytebeam cloud ) exists in SPIFFS partition with name `spiffs/device_config.json`. Check out [`/tools/provision`](https://github.com/bytebeamio/bytebeam-esp-rs-sdk/tree/main/tools/provision) to know how to flash it!




## ⚡ Running examples

Rename `cfg.toml.example` to `cfg.toml` and put your Wi-Fi credentials.

You can use [cargo espflash](https://github.com/esp-rs/espflash) to build the project and flash it. Connect your ESP board using USB and run the following command:

```sh

cargo espflash --release --monitor --partition-table  --example  --erase-otadata

```

> For developing in Rust on ESP, we will need to setup rust compiler and toolchains. This can easily be done by [`espup`](https://esp-rs.github.io/book/installation/installation.html#espup).

Use the same `` which you have used for provisioning certificates!

e.g. To run [actions](https://github.com/bytebeamio/bytebeam-esp-rs-sdk/blob/main/examples/actions.rs) example, with the given [partitions_example.csv](https://github.com/bytebeamio/bytebeam-esp-rs-sdk/blob/main/partitions_example.csv) 

```sh

cargo espflash --example actions --release --monitor --partition-table ./partitions_example.csv --erase-otadata

```




## ⚙️ Advance Configs

If you want to use different version of ESP IDF, or want to change the install location, you can change `[env]` in `.cargo/config.toml`.




## 🚧 Need Help?

Found some bug or need help with something? Feel free to open issues. You can open PRs as well for contributing.