tosca-esp32c3 0.1.1

A library for building Tosca firmware that runs on ESP32-C3 boards.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

<div align="center">

# `tosca-esp32c3`

[![Crates.io Version][crates.io badge]][crates.io]
[![LICENSE][license badge]][license]

</div>

A library crate for building firmware for `tosca` devices using an `ESP32-C3`
microcontroller.

It provides APIs to:

- Connect a device to a `Wi-Fi` access point
- Build the network stack
- Configure the `mDNS-SD` discovery service
- Define events for specific route tasks
- Initialize and run an `HTTP` server

The device APIs are designed to guide developers in defining their own
devices, aiming to minimize the ambiguities that could arise during
firmware development.

Currently, only a light device is implemented as a device.
However, this does not prevent the addition of other devices without altering
the overall crate structure.

## Build Process

To compile this crate with the `debug` profile, run:

```console
cargo build
```

To compile this crate with the `release` profile, which applies all
optimizations for faster performance and reduced memory usage, run:

```console
cargo build --release
```

## Build process for firmware devices

The [examples](https://github.com/ToscaLabs/tosca/tree/master/crates/tosca-esp32c3/examples)
directory includes firmware examples built with the `tosca-esp32c3` crate.
Each example is independent from another and can be moved to a separate
repository.

To build a firmware run:

```console
cd examples/[firmware directory name]
cargo build
```

To flash and run the firmware on an `ESP32-C3` board:

```console
cd examples/[firmware directory name]
cargo run --release
```

> [!IMPORTANT]
> Always use the release profile `[--release]` when building esp-hal.
  The dev profile can potentially be one or more orders of magnitude
  slower than release profile, and may cause issues with timing-sensitive
  peripherals and/or devices.

<!-- Links -->
[crates.io]: https://crates.io/crates/tosca-esp32c3
[license]: https://github.com/ToscaLabs/tosca?tab=readme-ov-file#license

<!-- Badges -->
[crates.io badge]: https://img.shields.io/crates/v/tosca-esp32c3.svg
[license badge]: https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg