summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYves Fischer <yvesf+git@xapek.org>2021-12-31 23:57:29 +0100
committerYves Fischer <yvesf+git@xapek.org>2021-12-31 23:57:29 +0100
commitd0c7100b706d70dfff342def2bac864693fe8544 (patch)
tree333268ca977222e2f5a41eff68607b36721f7694 /README.md
parentcaae83f445935c06cd6aef36f283a4688675278a (diff)
parent810721ceac0249e747cdf36f3edec22d829d4371 (diff)
downloadebus-master.tar.gz
ebus-master.zip
Merge branch 'ebus-rust'HEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/README.md b/README.md
index 983d397..bce45f8 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-# Ebus Tools
+# eBus
-## ebus-racket
+- [ebus-racket](ebus-racket/) eBus protocol parser written in racket
+- [ebus-rust](ebus-rust/) eBus protocol parser writtin in rust
+- [ebus-xml](ebus-xml/) eBus protocol specification (devices, packets, fields) in xml.
-Ebus protocol parser written in [racket](http://www.racket-lang.org).
+## Usage of ebus-rust on nixos
-## ebus-xml
-
-Ebus protocol specification (devices, packets, fields) in xml. \ No newline at end of file
+```
+ inputs.ebus.url = "github:yvesf/ebus";
+ inputs.ebus.inputs.nixpkgs.follows = "template/nixpkgs";
+ ...
+ # add module
+ ebus.nixosModules.ebus-rust
+ ...
+ # configure module
+ services.ebus-rust.enable = true;
+ services.ebus-rust.user = settings.username;
+ services.ebus-rust.device = "/dev/ttyUSB0";
+ ...
+``` \ No newline at end of file