matrix_rhal 0.0.4

The Rust implementation of MATRIX HAL.
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# MATRIX Rust Hardware Abstraction Layer

[![API](https://docs.rs/matrix_rhal/badge.svg)](https://docs.rs/matrix_rhal/)
[![Crate](https://img.shields.io/crates/v/matrix-rhal.svg)](https://crates.io/crates/matrix_rhal)
![crates.io Deployment](https://github.com/matrix-io/matrix-rhal/workflows/crates.io%20Deployment/badge.svg)

MATRIX RHAL is the Rust implementation of MATRIX HAL. The goal is to center around calling the MATRIX Kernel Modules and have most/all of HAL's features in this layer.

# Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
matrix_rhal = "0.0.4"
```

# Roadmap

Below are the current/planned features in RHAL.

- [x] Device information
- [x] Sensor Reading
  - [x] UV
  - [x] Pressure
  - [x] Humidity
  - [x] IMU
- [x] Everloop
- [x] GPIO
  - [x] Digital Read/Write
  - [x] PWM Write
- [ ] Microphone
- [ ] Documentation

# Dependencies

Run the following commands individually on your Raspberry Pi.

```bash
# Add matrix repository & key
curl https://apt.matrix.one/doc/apt-key.gpg | sudo apt-key add -
echo "deb https://apt.matrix.one/raspbian $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/matrixlabs.list

# Update packages
sudo apt-get update
sudo apt-get upgrade

# Install MATRIX Init Package
sudo apt-get install matrixio-creator-init

# Restart system
sudo reboot

# Install MATRIX kernel Modules
sudo apt install matrixio-kernel-modules

# Restart a second time
sudo reboot
```

# Building From Source (Raspberry Pi)

Building directly on your Raspberry Pi will lead to slower compilation times, due to the lack processing power.

Install git.

```bash
sudo apt install git
```

Clone the repository.

```bash
git clone https://github.com/Hermitter/matrix-rhal
```

Install Rust on the pi.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

Add MATRIX RHAL as a dependency to your Rust project.

- [Cargo Path Dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies)

# Building From Source (Cross Compile)

To reduce compilation times, it's recommended to build RHAL on your computer and deploy it to the Pi. This ends up saving time and sanity during development. Below are some guides to help set up this workflow:

- [Docker](https://github.com/rust-embedded/cross)
- [Linux](https://chacin.dev/blog/cross-compiling-rust-for-the-raspberry-pi)
- [Windows & macOS](https://dev.to/h_ajsf/cross-compiling-rust-for-raspberry-pi-4iai)