diff --git a/README.md b/README.md index 943c379..ea6f137 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,54 @@ -

-LNPoS -

+# LNPoS, the DIY Point of Sale device +Check out this [video tutorial](https://twitter.com/arcbtc/status/1585605023337168896) on the Makerbits channel or the +original demo. ## Free and open-source bitcoin point-of-sale ## Easy setup using browser https://lnpos.lnbits.com +### LNPoS includes -LNPoS includes: +- Online LN payments (former LNPoS project) +- Offline LN payments (former LNURLPoS project) +- Offline LN withdraw links (LNURLATM) +- Optional onchain payments -- LNPoS (for online LN payments, original project) -- LNURLPoS (for offline LN payments, original project ) -- OnChain (for onchain payments) -- LNURLATM (for making offline LN withdraw links). -

+### What you need: +- Lilygo TTGO/Tdisplay +- The Lilygo Keyboard specifically made for LNPoS +=> or get yourself the LNPoS Kit, dimensions 40x52x11mm e.g. in the [LNbits shop](https://shop.lnbits.com/product-category/hardware/point-of-sale-devices) +- 3.7V lithium iron flat battery with 1.25mm JST with < 1000 mAh to fit inside the standard LNPoS Kit +- LNbits LNURLdevice extension - What you need: -- The Lilygo Tdisplay is a cheap and small ESP32/screen development board. -- You can either attach a keypad membrane or use the breakout board Lilygo specifically made for the LNURLPoS! -- Any 3.7V lithium iron flat battery with 1.25mm JST connector should be fine. Go for at least 1000 mAh. If you want the battery to fit inside the breakout board, max. dimensions are 40x52x11mm. Example 1100 mAh 3.7V battery. +Got questions ? Join us t.me/lnbits, t.me/makerbits -Original demo -Video tutorial https://twitter.com/arcbtc/status/1585605023337168896 - -Join our telegram group MakerBits - -

-Configuring -

- -> Go to `settings` to lanch USB config mode or wifi access point -> If using access opint the device SSID default password is "ToTheMoon1" - -### LNPoS – Online Lightning Network payments - -Invoices are generated and checked from LNbits install. - -#### Setting up - -## Easy setup using browser https://lnbits.github.io/lnpos/installer/ - -## WiFi Access Point config +# Configuring the wifi Launch portal and enter an LNbits endpoint (ie.legend.lnbits.com), invoice key, and a fiat currency to make things easier for product pricing. +Go to `settings` to lanch USB config mode or wifi access point +If using access point the device SSID default password is "ToTheMoon1" + + ### LNURLPoS – Offline Lightning Network payments A random pin generated on the device is encrypted and passed trough the payee. When the payment has been made the unencrypted pin is sent as a receipt. This function makes use of LNURL-pay protocol. Uses LNbits LNURLDevice extension. -#### Setting up +#### Setting up LNURLPoS Launch portal and enter the string from the LNURLDevice extension on LNbits -### OnChain – Generate fresh addresses using an xPub +### Onchain – Generate fresh addresses using an xPub Use an xPub to generate a fresh address for every payment. Useful for large purchases. Includes a mempool.space QR so the payment can be verified. -#### Setting up +#### Setting up onchain connection Launch portal and enter BIP39 xPub and a pin, to make the function secure. @@ -70,17 +56,18 @@ Launch portal and enter BIP39 xPub and a pin, to make the function secure. ### LNURLATM – Meatbag ATM, give refunds, accept cash for sats. -Create withdraw/faucet links. Uses more-or-les. This function makes use of LNURL-withdraw protocol. Uses LNbits LNURLDevice extension. +Create withdraw/faucet links. Uses more-or-less. This function makes use of LNURL-withdraw protocol. Uses LNbits LNURLDevice extension. -#### Setting up +#### Setting up LNURLATM Launch portal and enter the string from the LNURLDevice extension on LNbits -

-Software installation: + +# Alternative installation (without webinstaller) + - Install Arduino IDE 1.8.19 - Install ESP32 boards, using boards manager - Role back ESP32 boards to 2.0.1 in boards manager @@ -95,7 +82,8 @@ Software installation: > Press/hold any button on the keypad during startup to launch portal. > Default password is "ToTheMoon1" (without the quotes) + > _Note: If using MacOS, you will need the CP210x USB to UART Bridge VCP Drivers available here https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers_ > If you are using **MacOS Big Sur or an Mac with M1 chip**, you might encounter the issue `A fatal error occurred: Failed to write to target RAM (result was 0107)`, this is related to the chipsest used by TTGO, you can find the correct driver and more info in this GitHub issue - +If you want to build something new from the parts, check out the [LNbits wiki](https://github.com/lnbits/lnbits/wiki/Tooling-&-Building-with-LNbits) to see some examples.