From 9daecc93b65d476b61968fb4dc73710d65c42c44 Mon Sep 17 00:00:00 2001 From: sigurg Date: Wed, 19 Sep 2018 14:59:15 +0200 Subject: [PATCH] Create README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa2f4fe --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# sailfishos-mooshimeter +[SailfishOS](https://sailfishos.org/) app for the [Mooshimeter](https://moosh.im/mooshimeter/) BluetoothLE Multimeter + +This app is in early alpha stage, and has only been tested in my phone (Aquafish) with my meter, so expect plenty of bugs :) + +**To use the app, you must enter the Bluetooth ID of your Mooshimeter in the app's settings dialog.** + + +## What works: +* display basic readings +* select input channels and ranges +* "math" channel (power calculations and K-Thermocouple) +* battery level indicator +* temperatur units (Celcius / Kelvin / Fahrenheit) + +## What doesn't work: +* there is no scanning/connection dialog to connect to a meter +* logging is not yet supported +* there are no pretty graphs (not even ugly ones) +* probably a lot of other features I can't think of right now :) + +## Known bugs: +* app sometimes fails to start because connection to the Mooshimeter fails. In this case, you need to kill the app manually using the terminal command "pkill -9 Mooshimeter".