rpi_embedded/
lib.rs

1// Copyright (c) 2017-2019 Rene van der Meer
2//
3// Permission is hereby granted, free of charge, to any person obtaining a
4// copy of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
16// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19// DEALINGS IN THE SOFTWARE.
20
21//! rpi_embedded is a fork of the RPPAL library. This fork is made to increase the usability
22//! of the RPPAL library. Spesificaly making it more user friendly and beginer friendly
23//! rpi_embedded provides access to the Raspberry Pi's GPIO, I2C, PWM, SPI, UART and Bluetooth
24//! peripherals. There is also a ADXL345 and pwm servo library included for ease of use.
25//! RPPAL also offers support for USB to serial adapters. The library
26//! can be used in conjunction with a variety of platform-agnostic drivers
27//! through its `embedded-hal` trait implementations by enabling the optional
28//! `hal` feature. However the new functions included in rpi_embedded might fail.
29//!
30//! rpi_embedded requires Raspbian or any similar, recent, Linux distribution.
31//! rpie_embedded has only been tested on Rpi Zero W but RPPAL is compatible with
32//! the Raspberry Pi A, A+, B, B+, 2B, 3A+, 3B, 3B+, 4B, CM, CM 3, CM 3+, Zero and
33//! Zero W. In theory it should all work except for bluetooth maybe.
34//!
35//! Note that this fork is still in production, and might change massivly from version to version
36
37
38// Used by rustdoc to link other crates to rppal's docs
39#![doc(html_root_url = "https://docs.rs/rpi_embedded")]
40
41#[macro_use]
42mod macros;
43
44pub mod gpio;
45#[cfg(feature = "hal")]
46pub mod hal;
47pub mod i2c;
48pub mod pwm;
49pub mod spi;
50pub mod system;
51pub mod uart;
52pub mod servo;
53pub mod adxl;
rpi_embedded/lib.rs

rpi_embedded/
lib.rs
