Organised folders

arcbtc · May 10, 2020 · be9e6d3 · be9e6d3
1 parent 5f8e82a
commit be9e6d3
Show file tree

Hide file tree

Showing 31 changed files with 47 additions and 7 deletions.
diff --git a/M5StackSatsLNBITS/M5StackSatsLNBITS.ino → M5StackSats/M5StackSats.ino b/M5StackSatsLNBITS/M5StackSatsLNBITS.ino → M5StackSats/M5StackSats.ino
diff --git a/M5StackSatsLNBITS/lnbits.c → M5StackSats/lnbits.c b/M5StackSatsLNBITS/lnbits.c → M5StackSats/lnbits.c
diff --git a/DIYquickening.h → M5StackSatsOther/DIYquickening.h b/DIYquickening.h → M5StackSatsOther/DIYquickening.h
diff --git a/ForAdvancedUsers/DIYv.h → M5StackSatsOther/ForAdvancedUsers/DIYv.h b/ForAdvancedUsers/DIYv.h → M5StackSatsOther/ForAdvancedUsers/DIYv.h
diff --git a/ForAdvancedUsers/ForAdvancedUsers.ino → ...her/ForAdvancedUsers/ForAdvancedUsers.ino b/ForAdvancedUsers/ForAdvancedUsers.ino → ...her/ForAdvancedUsers/ForAdvancedUsers.ino
diff --git a/ForAdvancedUsers/LNPaySource.cpp → ...atsOther/ForAdvancedUsers/LNPaySource.cpp b/ForAdvancedUsers/LNPaySource.cpp → ...atsOther/ForAdvancedUsers/LNPaySource.cpp
diff --git a/ForAdvancedUsers/LNimg.h → M5StackSatsOther/ForAdvancedUsers/LNimg.h b/ForAdvancedUsers/LNimg.h → M5StackSatsOther/ForAdvancedUsers/LNimg.h
diff --git a/ForAdvancedUsers/M5Stack.h → M5StackSatsOther/ForAdvancedUsers/M5Stack.h b/ForAdvancedUsers/M5Stack.h → M5StackSatsOther/ForAdvancedUsers/M5Stack.h
diff --git a/ForAdvancedUsers/PaymentConnector.h → ...Other/ForAdvancedUsers/PaymentConnector.h b/ForAdvancedUsers/PaymentConnector.h → ...Other/ForAdvancedUsers/PaymentConnector.h
diff --git a/ForAdvancedUsers/README.md → M5StackSatsOther/ForAdvancedUsers/README.md b/ForAdvancedUsers/README.md → M5StackSatsOther/ForAdvancedUsers/README.md
diff --git a/M5Stack.h → M5StackSatsOther/M5Stack.h b/M5Stack.h → M5StackSatsOther/M5Stack.h
diff --git a/M5StackSatsBTCPAY/BTCPAYSplash.c → ...atsOther/M5StackSatsBTCPAY/BTCPAYSplash.c b/M5StackSatsBTCPAY/BTCPAYSplash.c → ...atsOther/M5StackSatsBTCPAY/BTCPAYSplash.c
diff --git a/M5StackSatsBTCPAY/BTCPAYSplash.png → ...sOther/M5StackSatsBTCPAY/BTCPAYSplash.png b/M5StackSatsBTCPAY/BTCPAYSplash.png → ...sOther/M5StackSatsBTCPAY/BTCPAYSplash.png
diff --git a/M5StackSatsBTCPAY/M5StackSatsBTCPAY.ino → ...r/M5StackSatsBTCPAY/M5StackSatsBTCPAY.ino b/M5StackSatsBTCPAY/M5StackSatsBTCPAY.ino → ...r/M5StackSatsBTCPAY/M5StackSatsBTCPAY.ino
diff --git a/M5StackSatsBTCPAY/README.md → M5StackSatsOther/M5StackSatsBTCPAY/README.md b/M5StackSatsBTCPAY/README.md → M5StackSatsOther/M5StackSatsBTCPAY/README.md
diff --git a/M5StackSatsBTCPAY/apikey.png → ...ackSatsOther/M5StackSatsBTCPAY/apikey.png b/M5StackSatsBTCPAY/apikey.png → ...ackSatsOther/M5StackSatsBTCPAY/apikey.png
diff --git a/M5StackSatsBTCPAY/preview.jpg → ...ckSatsOther/M5StackSatsBTCPAY/preview.jpg b/M5StackSatsBTCPAY/preview.jpg → ...ckSatsOther/M5StackSatsBTCPAY/preview.jpg
diff --git a/M5StackSatsBLITZ/BLITZSplash.c → ...ackSatsOther/M5StackSatsLND/BLITZSplash.c b/M5StackSatsBLITZ/BLITZSplash.c → ...ackSatsOther/M5StackSatsLND/BLITZSplash.c
diff --git a/M5StackSatsBLITZ/M5StackSatsLND.ino → ...tsOther/M5StackSatsLND/M5StackSatsLND.ino b/M5StackSatsBLITZ/M5StackSatsLND.ino → ...tsOther/M5StackSatsLND/M5StackSatsLND.ino
diff --git a/M5StackSatsLNPAY/LNPAYSplash.c → ...kSatsOther/M5StackSatsLNPAY/LNPAYSplash.c b/M5StackSatsLNPAY/LNPAYSplash.c → ...kSatsOther/M5StackSatsLNPAY/LNPAYSplash.c
diff --git a/M5StackSatsLNPAY/M5StackSatsLNPAY.ino → ...her/M5StackSatsLNPAY/M5StackSatsLNPAY.ino b/M5StackSatsLNPAY/M5StackSatsLNPAY.ino → ...her/M5StackSatsLNPAY/M5StackSatsLNPAY.ino
diff --git a/M5StackSatsLNPAY/readme.md → M5StackSatsOther/M5StackSatsLNPAY/readme.md b/M5StackSatsLNPAY/readme.md → M5StackSatsOther/M5StackSatsLNPAY/readme.md
diff --git a/M5StackSatsLNTX/LNTX.c → M5StackSatsOther/M5StackSatsLNTX/LNTX.c b/M5StackSatsLNTX/LNTX.c → M5StackSatsOther/M5StackSatsLNTX/LNTX.c
diff --git a/M5StackSatsLNTX/M5StackSatsLNTX.ino → ...Other/M5StackSatsLNTX/M5StackSatsLNTX.ino b/M5StackSatsLNTX/M5StackSatsLNTX.ino → ...Other/M5StackSatsLNTX/M5StackSatsLNTX.ino
diff --git a/M5StackSatsON/M5StackSatsON.ino → ...SatsOther/M5StackSatsON/M5StackSatsON.ino b/M5StackSatsON/M5StackSatsON.ino → ...SatsOther/M5StackSatsON/M5StackSatsON.ino
diff --git a/M5StackSatsON/ONSplash.c → M5StackSatsOther/M5StackSatsON/ONSplash.c b/M5StackSatsON/ONSplash.c → M5StackSatsOther/M5StackSatsON/ONSplash.c
diff --git a/M5StackSatsZAP/M5StackSatsZAP.ino → ...tsOther/M5StackSatsZAP/M5StackSatsZAP.ino b/M5StackSatsZAP/M5StackSatsZAP.ino → ...tsOther/M5StackSatsZAP/M5StackSatsZAP.ino
diff --git a/M5StackSatsZAP/README.md → M5StackSatsOther/M5StackSatsZAP/README.md b/M5StackSatsZAP/README.md → M5StackSatsOther/M5StackSatsZAP/README.md
diff --git a/M5StackSatsOther/README.md b/M5StackSatsOther/README.md
@@ -0,0 +1,46 @@
+![M5StackSats](https://i.imgur.com/zGZpYhn.png)
+
+# M5StackSats
+
+A bitcoin Lightning-Network Point of Sale terminal using the ESP32 based M5Stack Faces Development Kit. Included in the kit is a keypad and charging dock, making it an ideal candidate for an cheap($55)/easy DIY bitcoin point of sale terminal.
+https://m5stack.com/products/face
+
+[![bitcoinpos](https://i.imgur.com/sHp1AXw.png)](https://www.youtube.com/watch?v=KPI54s1xXsc)
+
+There are three implementations of M5StackSats, one that communicates directly with an LND node, and another that communicates with opennode (make an account here https://opennode.co/join/f774f2a0-1377-45e2-b719-6b821f24900d), and another that sits between the two projects using a neutrino LND node via Zap desktop wallet(https://docs.zaphq.io/docs-desktop-neutrino-connect).
+
+Converting the project to communicate with c-lightning nodes/other custodial services should be easy.
+
+## Tutorial
+
+[![bitcoinpos](https://i.imgur.com/uwLAbot.png)](https://www.youtube.com/watch?v=o4jqUbmypRQ)
+
+## Installing Arduino + libraries
+
+Install the
+[Arduino IDE](https://www.arduino.cc/en/Main/Software) and
+[ESP32 hardware](https://github.com/espressif/arduino-esp32#installation-instructions).
+
+From "Manage Libraries" install,
+
+- LittlevGL
+- ArduinoJson
+- M5Stack
+
+![a](https://i.imgur.com/mCfnhZN.png)
+
+## Notes
+
+To create a splash image, you can use the
+[Online Image to C Array Converter](https://littlevgl.com/image-to-c-array).
+
+Here you can find some more information on the
+[client server communication](https://arduino-esp8266.readthedocs.io/en/latest/esp8266wifi/client-examples.html).
+
+For parsing JSON responses and calculating the capacity you can use the
+[ArduinoJson Assistant](https://arduinojson.org/v6/assistant/) tool.
+
+## Tip me
+
+If you like this project and might even use or extend it, why not
+[send some tip love](https://paywall.link/to/f4e4e)!
diff --git a/main.ino → M5StackSatsOther/main.ino b/main.ino → M5StackSatsOther/main.ino
diff --git a/README.md b/README.md
@@ -1,16 +1,10 @@
-![M5StackSats](https://i.imgur.com/zGZpYhn.png)
-
 # M5StackSats
 
 A bitcoin Lightning-Network Point of Sale terminal using the ESP32 based M5Stack Faces Development Kit. Included in the kit is a keypad and charging dock, making it an ideal candidate for an cheap($55)/easy DIY bitcoin point of sale terminal.
 https://m5stack.com/products/face
 
 [![bitcoinpos](https://i.imgur.com/sHp1AXw.png)](https://www.youtube.com/watch?v=KPI54s1xXsc)
 
-There are three implementations of M5StackSats, one that communicates directly with an LND node, and another that communicates with opennode (make an account here https://opennode.co/join/f774f2a0-1377-45e2-b719-6b821f24900d), and another that sits between the two projects using a neutrino LND node via Zap desktop wallet(https://docs.zaphq.io/docs-desktop-neutrino-connect).
-
-Converting the project to communicate with c-lightning nodes/other custodial services should be easy.
-
 ## Tutorial
 
 [![bitcoinpos](https://i.imgur.com/uwLAbot.png)](https://www.youtube.com/watch?v=o4jqUbmypRQ)
@@ -43,4 +37,4 @@ For parsing JSON responses and calculating the capacity you can use the
 ## Tip me
 
 If you like this project and might even use or extend it, why not
-[send some tip love](https://paywall.link/to/f4e4e)!
+[send some tip love](https://lnbits.com/paywall/fZVEW2jjdar9pC3psahc3Z)!