Skip to content

Commit fe007bd

Browse files
committed
Fill in README
1 parent bad8870 commit fe007bd

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
grisp_emulation
2-
=====
1+
# grisp_emulation
32

4-
An OTP library
3+
This is a hardware emulation layer for the
4+
[GRiSP runtime](https://github.com/grisp/grisp). With this, you can replace the
5+
GRiSP specific low-level drivers with a native Erlang emulation. This allows you
6+
to run the GRiSP runtime on a normal development computer instead of on the
7+
board.
58

6-
Build
7-
-----
9+
The emulation layer comes with a few different emulated Pmod drivers:
810

9-
$ rebar3 compile
11+
* PmodACL2
12+
* PmodGYRO
13+
* PmodNAV
14+
15+
The emulated drivers are in various states of development, ranging from just
16+
barely starting to a semi-full emulated state of hardware components.
17+
Contributions adding new drivers are welcome!
18+
19+
It also comes with an emulation structure for changing the low-level drivers:
20+
21+
* SPI
22+
* GPIO
23+
* I2C
24+
25+
This is what the emulated drivers above hook into to fake actual hardware.

0 commit comments

Comments
 (0)