daisy 0.11.0

A board support package for the Electro-Smith Daisy Seed and Patch SM
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# Daisy

Rust `no_std`, `embedded_hal` board support package for the Electro-Smith Daisy
platform.

* [Documentation](https://zlosynth.com/daisy)
* [Crate (crates.io)](https://crates.io/crates/daisy)
* [Repository (github.com)](https://github.com/zlosynth/daisy)

# Supported boards

Currently this library supports following boards:

* [Daisy Seed](https://www.electro-smith.com/daisy/daisy) (codec AK4556), `seed`
* [Daisy Seed 1.1](https://www.electro-smith.com/daisy/daisy) (codec WM8731), `seed_1_1`
* [Daisy Seed 1.2](https://www.electro-smith.com/daisy/daisy) (codec PCM3060), `seed_1_2`
* [Daisy Patch SM](https://www.electro-smith.com/daisy/patch-sm) (codec PCM3060), `patch_sm`

Select the board by using its respective feature.

# Flashing an example

Using DFU. Connect using a sigle USB cable, click BOOT+RESET before flashing:

```sh
make flash-dfu WHAT=blinky BOARD=seed_1_1
```

Using [`probe-rs`](https://probe.rs/). This requires ST-Link probe, but provides
additional logs and panic messages:

```sh
make flash WHAT=blinky BOARD=seed_1_1
```

Using [Daisy Bootloader](https://electro-smith.github.io/libDaisy/md_doc_2md_2__a7___getting-_started-_daisy-_bootloader.html).
This extends the maximum firmware capacity. You can find a guide with an example under
[examples/bootloader](examples/bootloader/).

# Sampling rate

By default, the audio sampling rate is set to 48 kHz. This can be increased to
96 kHz by enabling the `sampling_rate_96khz` feature.

# Block length

By default, the audio block length is 32 frames. This can be increased to 64
by enabling the `block_length_64` feature.

# API stability

I am still trying to figure out a good API for the project. Expect it to change.
To mitigate breakage of your code on library update, use macros defined under
`board.rs` to initialize resources whenever possible.

# HAL compatibility

This library is closely tied to [stm32h7xx-hal](https://github.com/stm32-rs/stm32h7xx-hal/).
Make sure to use compatible versions in your `Cargo.toml`.

| **Daisy**   | **HAL** |
|-------------|---------|
| `0.10`      | `0.16`  |
| `0.9`       | `0.15`  |
| `0.8`       | `0.14`  |
| `0.2`-`0.7` | `0.12`  |
| `0.1`       | `0.11`  |

# Razor

* This library aims to abstract all peripherals that are available on Daisy.
* This library will **not** abstract anything that is not on Daisy, e.g. pots,
  SD cards, MIDI, ...

# License

This library is distributed under the terms of the MIT license. See
[LICENSE](LICENSE) for details.

This project was forked from
[antoinevg/daisy_bsp](https://github.com/antoinevg/daisy_bsp).
Kudos to Antoine for making his library public.

# Changelog

Read the [CHANGELOG.md](CHANGELOG.md) to learn about changes introduced in each
release.

# Versioning

See [VERSIONING.md](VERSIONING.md) to find detailed information about versioning
of the project.