Skip to content

Commit 0757886

Browse files
arbadacarbaYKdni
andauthored
docs: webinstaller link was old, typos and formatting (#19)
* Webinstaller link was old, typos and formatting --------- Co-authored-by: dni ⚡ <[email protected]>
1 parent 892fd10 commit 0757886

File tree

1 file changed

+30
-42
lines changed

1 file changed

+30
-42
lines changed

README.md

+30-42
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,73 @@
11
<img src="images/tdisplay.png?raw=true">
22

3-
<h1>
4-
LNPoS
5-
</h1>
3+
# LNPoS, the DIY Point of Sale device
64

5+
Check out this [video tutorial](https://twitter.com/arcbtc/status/1585605023337168896) on the Makerbits channel or the
6+
<a href="https://twitter.com/arcbtc/status/1484942260013838336">original demo</a>.
77
## Free and open-source bitcoin point-of-sale
88
## Easy setup using browser https://lnpos.lnbits.com
99

10+
### LNPoS includes
1011

11-
LNPoS includes:
12+
- Online LN payments (former <a href="https://github.com/arcbtc/LNPoS">LNPoS project</a>)
13+
- Offline LN payments (former <a href="https://github.com/arcbtc/LNURLPoS">LNURLPoS project</a>)
14+
- Offline LN withdraw links (LNURLATM)
15+
- Optional onchain payments
1216

13-
- LNPoS (for online LN payments, original <a href="https://github.com/arcbtc/LNPoS">project</a>)
14-
- LNURLPoS (for offline LN payments, original <a href="https://github.com/arcbtc/LNURLPoS">project</a> )
15-
- OnChain (for onchain payments)
16-
- LNURLATM (for making offline LN withdraw links).
17-
<br></br>
17+
### What you need:
18+
- Lilygo <a href="https://www.aliexpress.com/item/33048962331.html">TTGO/Tdisplay</a>
19+
- The <a href="https://www.aliexpress.com/item/1005003589706292.html">Lilygo Keyboard</a> specifically made for LNPoS
20+
=> or get yourself the <a href="https://www.aliexpress.com/item/1005003589706292.html">LNPoS Kit</a>, dimensions 40x52x11mm e.g. in the [LNbits shop](https://shop.lnbits.com/product-category/hardware/point-of-sale-devices)
21+
- 3.7V lithium iron flat battery with 1.25mm JST with < 1000 mAh to fit inside the standard LNPoS Kit
22+
- LNbits LNURLdevice extension
1823

19-
What you need:
20-
- The Lilygo <a href="https://www.aliexpress.com/item/33048962331.html">Tdisplay</a> is a cheap and small ESP32/screen development board.
21-
- You can either attach a <a href="https://www.aliexpress.com/item/32993999306.html">keypad membrane</a> or use the <a href="https://www.aliexpress.com/item/1005003589706292.html">breakout board</a> Lilygo specifically made for the LNURLPoS!
22-
- 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 <a href="https://www.aliexpress.com/item/1005003589706292.html">breakout board</a>, max. dimensions are 40x52x11mm. Example <a href="https://aliexpress.com/item/32948764265.html">1100 mAh 3.7V battery</a>.
24+
Got questions ? Join us <a href="https://t.me/lnbits">t.me/lnbits</a>, <a href="https://t.me/makerbits">t.me/makerbits</a>
2325

24-
Original <a href="https://twitter.com/arcbtc/status/1484942260013838336">demo</a>
2526

26-
Video tutorial <a href="https://twitter.com/arcbtc/status/1585605023337168896">https://twitter.com/arcbtc/status/1585605023337168896</a>
27-
28-
Join our telegram group <a href="https://t.me/makerbits">MakerBits</a>
29-
30-
<h2>
31-
Configuring
32-
</h2>
33-
34-
> Go to `settings` to lanch USB config mode or wifi access point
35-
> If using access opint the device SSID default password is "ToTheMoon1"
36-
37-
### LNPoS – Online Lightning Network payments
38-
39-
Invoices are generated and checked from LNbits install.
40-
41-
#### Setting up
42-
43-
## Easy setup using browser https://lnbits.github.io/lnpos/installer/
44-
45-
## WiFi Access Point config
27+
# Configuring the wifi
4628

4729
Launch portal and enter an LNbits endpoint (ie.legend.lnbits.com), invoice key, and a fiat currency to make things easier for product pricing.
4830

31+
Go to `settings` to lanch USB config mode or wifi access point
32+
If using access point the device SSID default password is "ToTheMoon1"
33+
4934
<img src="images/lnpos.png?raw=true" width="75%">
5035

36+
5137
### LNURLPoS – Offline Lightning Network payments
5238

5339
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.
5440

55-
#### Setting up
41+
#### Setting up LNURLPoS
5642

5743
Launch portal and enter the string from the LNURLDevice extension on LNbits
5844

5945
<img src="images/lnurlpos.png?raw=true" width="75%">
6046

61-
### OnChain – Generate fresh addresses using an xPub
47+
### Onchain – Generate fresh addresses using an xPub
6248

6349
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.
6450

65-
#### Setting up
51+
#### Setting up onchain connection
6652

6753
Launch portal and enter BIP39 xPub and a pin, to make the function secure.
6854

6955
<img src="images/onchain.png?raw=true" width="75%">
7056

7157
### LNURLATM – Meatbag ATM, give refunds, accept cash for sats.
7258

73-
Create withdraw/faucet links. Uses more-or-les. This function makes use of LNURL-withdraw protocol. Uses LNbits LNURLDevice extension.
59+
Create withdraw/faucet links. Uses more-or-less. This function makes use of LNURL-withdraw protocol. Uses LNbits LNURLDevice extension.
7460

75-
#### Setting up
61+
#### Setting up LNURLATM
7662

7763
Launch portal and enter the string from the LNURLDevice extension on LNbits
7864

7965
<img src="images/lnurlatm.png?raw=true" width="75%">
8066

81-
<br></br>
8267

83-
Software installation:
68+
69+
# Alternative installation (without webinstaller)
70+
8471
- Install <a href="https://www.arduino.cc/en/software">Arduino IDE 1.8.19</a>
8572
- Install ESP32 boards, using <a href="https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager">boards manager</a>
8673
- Role back ESP32 boards to 2.0.1 in boards manager
@@ -95,7 +82,8 @@ Software installation:
9582
> Press/hold any button on the keypad during startup to launch portal.
9683
> Default password is "ToTheMoon1" (without the quotes)
9784
85+
9886
> _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_
9987
> 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 <a href="https://github.com/Xinyuan-LilyGO/LilyGo-T-Call-SIM800/issues/139#issuecomment-904390716">GitHub issue</a>
10088
101-
89+
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.

0 commit comments

Comments
 (0)