Skip to content

remove list of implementations and driver crates from the README ... #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 4 additions & 106 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,114 +51,12 @@ Issues used to track unproven APIs will be labeled as `unproven-api`s in the iss
may also include the labels `needs-impl` and `needs-driver` to signal what's required for them to
move to the set of proven traits.

## Implementations
## Implementations and drivers

These are (WIP) implementations of `embedded-hal` for various platforms. Feel free to send a PR
adding yours to the list!
For a list of `embedded-hal` implementations and driver crates check the [awesome-embedded-rust]
list.

You may be able to find even more implementations by searching for the [`embedded-hal-impl`] keyword
an crates.io. If you publish a `embedded-hal` implementation to crates.io please use that keyword to
let others more easily find your crate!

[`embedded-hal-impl`]: https://crates.io/keywords/embedded-hal-driver

### Linux

- [`linux-embedded-hal`]. For the Raspberry Pi and other SBC that expose pins with embedded
functionality (SPI, I2C, etc.)

[`linux-embedded-hal`]: https://crates.io/crates/linux-embedded-hal

### Nordic

- [`nrf51-hal`]. Check the [`microbit`] crate for examples that can be run on the [micro:bit]

[`nrf51-hal`]: https://crates.io/crates/nrf51-hal
[`microbit`]: https://crates.io/crates/microbit
[micro:bit]: http://microbit.org/

### NXP

- [`lpc82x-hal`]

[`lpc82x-hal`]: https://github.com/braun-robotics/rust-lpc82x-hal

- [`mkw41z-hal`]. Check the [`frdm-kw41z`] crate for examples that can be run on the NXP [FRDM-KW41Z] boards

[`mkw41z-hal`]: https://crates.io/crates/mkw41z-hal
[`frdm-kw41z`]: https://crates.io/crates/frdm-kw41z
[FRDM-KW41Z]: https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/kinetis-cortex-m-mcus/w-serieswireless-conn.m0-plus-m4/freedom-development-kit-for-kinetis-kw41z-31z-21z-mcus:FRDM-KW41Z

### ST Microelectronics

- [`stm32f042-hal`]. Contains examples that can be run on the [Nucleo-F042K6] and similar boards.

[`stm32f042-hal`]: https://crates.io/crates/stm32f042-hal
[Nucleo-F042K6]: http://www.st.com/en/evaluation-tools/nucleo-f042k6.html

- [`stm32f103xx-hal`]. Contains examples that can be run on the [Blue pill] and similar boards.

[`stm32f103xx-hal`]: https://github.com/japaric/stm32f103xx-hal
[Blue pill]: wiki.stm32duino.com/index.php?title=Blue_Pill

- [`stm32f30x-hal`]. Check the [`f3`] crate for examples that can be run on the STM32F3DISCOVERY.

[`stm32f30x-hal`]: https://crates.io/crates/stm32f30x-hal
[`f3`]: https://crates.io/crates/f3

### Texas Instruments

- [`tm4c123x-hal`]

[`tm4c123x-hal`]: https://github.com/thejpster/tm4c123x-hal

## Drivers

These are (WIP) platform agnostic drivers that can be used with any of the above implementations to
interface all sort of external devices like sensors and actuators. Feel free to send a PR adding
yours to the list!

You may be able to find even more implementations by searching for the [`embedded-hal-driver`]
keyword an crates.io. If you publish a driver to crates.io please use that keyword to let others
more easily find your crate!

- [`l3gd20`]. Gyroscope

[`l3gd20`]: https://crates.io/crates/l3gd20

- [`lsm303dlhc`]. Accelerometer + compass

[`lsm303dlhc`]: https://crates.io/crates/lsm303dlhc

- [`mag3110`]. Magnetometer

[`mag3110`]: https://crates.io/crates/mag3110

- [`mfrc522`]. RFID reader / writer

[`mfrc522`]: https://crates.io/crates/mfrc522

- [`motor-driver`]. Motor drivers like the L298N and the TB6612FNG

[`motor-driver`]: https://github.com/japaric/motor-driver

- [`mpu9250`]. Accelerometer + gyroscope + magnetometer IMU

[`mpu9250`]: https://github.com/japaric/mpu9250

- [`si5351`]. Clock generator

[`si5351`]: https://github.com/ilya-epifanov/si5351

- [`si7021`]. Humidity and temperature sensor

[`si7021`]: https://github.com/wose/si7021

- [`mcp3425`]. 16-bit ADC

[`mcp3425`]: https://github.com/dbrgn/mcp3425-rs/

[`embedded-hal-driver`]: https://crates.io/keywords/embedded-hal-driver
[awesome-embedded-rust]: https://github.com/rust-embedded/awesome-embedded-rust#driver-crates

## License

Expand Down