Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #58

Merged
merged 38 commits into from
Feb 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
56cf264
Pictures Update
AxelHamburch Feb 18, 2022
aceb3c6
Update display.md
AxelHamburch Feb 18, 2022
2dfa592
Update edit_config.md
AxelHamburch Feb 18, 2022
1bec288
Update tmux_monitoring.md
AxelHamburch Feb 18, 2022
4ad0e46
Update autostart.md
AxelHamburch Feb 18, 2022
1dfbda7
Update camera.md
AxelHamburch Feb 18, 2022
1b05ad4
Update edit_app.md
AxelHamburch Feb 18, 2022
e857f12
Add files via upload
AxelHamburch Feb 18, 2022
9a9184d
Update edit_config.md
AxelHamburch Feb 18, 2022
95a9afd
Update display.md
AxelHamburch Feb 18, 2022
fef05d3
Update wiring.md
AxelHamburch Feb 18, 2022
b14bfec
Update camera.md
AxelHamburch Feb 18, 2022
f8b4b6b
Update voltage_converter.md
AxelHamburch Feb 18, 2022
76b8a50
Update coin_validator.md
AxelHamburch Feb 18, 2022
5f0ee28
Update coin_validator.md
AxelHamburch Feb 18, 2022
4841afb
Update sdcard_and_wifi.md
AxelHamburch Feb 18, 2022
2155762
Update edit_config.md
AxelHamburch Feb 18, 2022
4465137
Update information_and_tips.md
AxelHamburch Feb 18, 2022
b8524fa
Update voltage_converter.md
AxelHamburch Feb 18, 2022
eae89da
Update voltage_converter.md
AxelHamburch Feb 18, 2022
a9b675e
Delete display_2.13inch.jpg
AxelHamburch Feb 18, 2022
0123cf9
Update autostart.md
AxelHamburch Feb 18, 2022
a3e67b4
Update display.md
AxelHamburch Feb 18, 2022
7c1c61f
Update edit_app.md
AxelHamburch Feb 18, 2022
8dba126
Update edit_config.md
AxelHamburch Feb 18, 2022
a99bee4
Update tmux_monitoring.md
AxelHamburch Feb 18, 2022
981c36a
Update voltage_converter.md
AxelHamburch Feb 19, 2022
ba90278
Update voltage_converter.md
AxelHamburch Feb 19, 2022
27ec3f5
Update coin_validator.md
AxelHamburch Feb 19, 2022
337f813
Update wiring.md
AxelHamburch Feb 19, 2022
1e95258
Update sdcard_and_wifi.md
AxelHamburch Feb 19, 2022
6794b8b
Update display.md
AxelHamburch Feb 19, 2022
7cd030d
Update edit_config.md
AxelHamburch Feb 19, 2022
35a33c7
Update edit_app.md
AxelHamburch Feb 19, 2022
eba85b2
Update tmux_monitoring.md
AxelHamburch Feb 19, 2022
4d163d3
Update autostart.md
AxelHamburch Feb 19, 2022
33b071d
Update camera.md
AxelHamburch Feb 19, 2022
0b61bcf
Update information_and_tips.md
AxelHamburch Feb 19, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/guide/autostart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,8 @@ $ sudo systemctl stop LightningATM.service
$ sudo systemctl start LightningATM.service
```

- Note: From now on the ATM will start automatically. If you want to observe the app.py in tmux, you should stop the "LightningATM.service" manually, bevor you start the app.py in the tmux.
- Note: From now on the ATM will start automatically after booting. If you want to observe the app.py in tmux, you should `stop` the "LightningATM.service" manually, bevor you start the app.py in the tmux. Don't forget to `start` the service again afterwards.

---

#### [tmux_monitoring](/docs/guide/tmux_monitoring.md) ᐊ previous | next ᐅ [camera](/docs/guide/camera.md)
4 changes: 3 additions & 1 deletion docs/guide/camera.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Installation and testing the camera

The 5MP Camera OV5647 for the Raspberry Pi is available from different manufacturers and with slightly different designs.
The camera is an optional feature and allows you to scan LNURL addresses. The 5MP Camera OV5647 is available from different manufacturers and with slightly different designs.
To test the function of the camera you can take a picture and download it to you computer.

### Installation
Expand Down Expand Up @@ -110,7 +110,9 @@ Note: This camera was pretty cheap and has a variable lens that was pretty loose

- You can do also videos. The command is `raspivid`

---

#### [autostart](/docs/guide/autostart.md) ᐊ previous | next ᐅ [information_and_tips](/docs/guide/information_and_tips.md)



Expand Down
4 changes: 4 additions & 0 deletions docs/guide/coin_validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,7 @@ coin validator
coin calibration
![coin calibration](../pictures/coin_validator_calibration.jpg)

---

#### [voltage_converter](/docs/guide/voltage_converter.md) ᐊ previous | next ᐅ [wiring](/docs/guide/wiring.md)

8 changes: 6 additions & 2 deletions docs/guide/display.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ $ sudo python3 ./epd_2in13_V2_test.py

If everything has been correctly connected and installed, the display will now show a demonstration and finally the screen will cleare.

display
![display](../pictures/display_2.13inch.jpg)
display demo

<img src="../pictures/display_demo.jpg" width="500">

---

#### [sdcard_and_wifi](/docs/guide/sdcard_and_wifi.md) ᐊ previous | next ᐅ [edit_config](/docs/guide/edit_config.md)
43 changes: 7 additions & 36 deletions docs/guide/edit_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ $ nano app.py

##### Optional setting *only for the pocket version:* Skip the "Prepare for LNURL" page:

- Search for `display.update_lnurl_cancel_notice()` with `CTRL+W`. (It exists twice)
- There is a place where it says `if activewallet == "lntxbot"`, please edit the two lines (see picture)
- Search for `display.update_lnurl_cancel_notice()` with `CTRL+W` or just scroll down a few lines.
- There is a place where it says `if activewallet == "lntxbot"`, please edit the two lines below (see picture)

###### Comment out the following two lines with `#`

Expand All @@ -21,43 +21,14 @@ $ nano app.py
# time.sleep(5)
```

-> This will skip the LNURL "query page" as it is not relevant for the pocket version (without push button).
-> This will skip the LNURL "query page" as it is not relevant to the pocket version

##### Alternative setting: coin preselection if the setting in config.ini does not work:

###### Adjustment of the pulses for the respective coins

- Search for `if config.PULSES == 2` in app.py with `CTRL+W`
- There you will find the setting options for the coins.
- Note: If you can't find `if config.PULSES == 2` in the app.py file, then you might have a higher version then V0.3.0 and the coin settings are in the config.ini. You can skip this point.

###### For example:

```
if config.PULSES == 2:
config.FIAT += 0.02
..
logger.info("2 cents added")
..
```

The settings are now set in the same way as the coin validator is parameterized:

###### For the example, two pulses = 5 cents

```
if config.PULSES == 2:
config.FIAT += 0.05
..
logger.info("5 cents added")
..
```
app.py - Skip the "Prepare for LNURL" (example only für ATM without push button)
![edit app](../pictures/edit_app_terminal_1.png)

- Repead the change up to 2 euros = 2.00 (200 cents)
- Note: As I said, you only have to do this if the setting in config.ini doesn't work
---

app.py - Skip the "Prepare for LNURL" (just an example)
![edit app](../pictures/edit_app_terminal_1.png)
#### [edit_config](/docs/guide/edit_config.md) ᐊ previous | next ᐅ [tmux_monitoring](/docs/guide/tmux_monitoring.md)



55 changes: 42 additions & 13 deletions docs/guide/edit_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ $ cd ~/LightningATM/
$ ./app.py
```

- The app.py (the ATM) was started and the config.ini file was created
- The display should now show `LightningATM` (You must have tested the display first!)
- The process or the ATM can be interrupted/stopped with `CTRL+C`
- After a short time, `Manually Interrupted` is shown in the terminal windos and you should see `ATM is turned off` on the display
- When you first start you will probably get an error message because the default display type is wrong. But you can ignore the message. The config.ini has now been created in the background.
- The "app.py" process can now be stopped with `CTRL+C`
- After a short time, `Manually Interrupted` is shown in the terminal window
- Now edit the config.ini as described below

### Open the config.ini file

Expand All @@ -26,14 +26,14 @@ $ nano ~/.lightningATM/config.ini

### Set the config.ini file

###### Enter display type under `[atm]`
#### Enter display type under `[atm]`

```
display = waveshare2in13v2
```
`Note:` Please compare the display type. Yours may require different settings.

###### *Only for Pocket Version:* Delay time (set from 0 to 12 seconds)
#### *Only for Pocket Version:* Delay time (set from 0 to 12 seconds)

```
payoutdelay = 12
Expand All @@ -42,7 +42,7 @@ $ nano ~/.lightningATM/config.ini
- Its needed for the the pocket version, because it has no push button for confimrmation. The invoice will be generated automatically after 12 seconds
- Note: If you have a button version, you must keep the 0.

###### Set activate wallet type / example LNTXBOT
#### Set activate wallet type / example LNTXBOT

- If you would like to set a BTCPayServer wallet, get further information here: [BTCPayServer](https://docs.lightningatm.me/lightningatm-setup/wallet-setup/lnd_btcpay)
- Note: A good guide to getting started with the LNTXBOT can be found here: [coincharge.io](https://coincharge.io/en/lntxbot-telegram-lightning-wallet/)
Expand All @@ -51,7 +51,7 @@ $ nano ~/.lightningATM/config.ini
activewallet = lntxbot
```

###### Under `[lntxbot]` enter the data for the API to the lntxbot
#### Under `[lntxbot]` enter the data for the API to the lntxbot

```
[lntxbot]
Expand All @@ -63,7 +63,9 @@ creds = abc..xyz==
- Note: The LNTXBOT delivers `url` and `creds` with the command `/lightningATM` from you Telegram bot
- The structure from the bot answer is build up like: `<creds>@<url>`

###### Set the coins to the pulses
#### Set the coins to the pulses

- Each coin generates a specific number of pulses. Here 2 to 7 pulses.

```
[coins]
Expand All @@ -76,16 +78,43 @@ coin_types = 2,0.05,5 eur cent
7,2.00,2 eur
```

- To save and exit the editor: `CTRL+x -> y -> ENTER`
- Note: In version 0.3.0 you still had to make the setting in app.py. I don't know which version you get, but if the settings with the config.ini don't work, you can set them directly in the app.py. I wrote something about that in the next chapter "[edit app.py](/docs/guide/edit_app.md)". But if you are lucky, it might be enough to set it here in the config.ini. You have to test it out. With the monitoring system (tmux), explanation see chapter "[tmux monitoring](/docs/guide/tmux_monitoring.md)", you can see that well.
- When you finshed with changings in the config.ini, save and exit the editor: `CTRL+x -> y -> ENTER`
- Note: In the config.ini you can also change the currency and fees

config.ini part 1 (just an example)
config.ini part 1 (example)
![config.ini part 1](../pictures/edit_config_terminal_1.png)

config.ini part 2 (just an example)
config.ini part 2 (example)
![config.ini part 2](../pictures/edit_config_terminal_2.png)

#### Test the settings (or the entire ATM) once

- Start the ATM again

```
$ cd ~/LightningATM/
$ ./app.py
```

- The display should now show `LightningATM`
- If everything is entered correctly, the ATM should now be ready for use
- Just test it with few coins
- If it doesn't work, the chapter with [`tmux`](/docs/guide/tmux_monitoring.md) will come later. You can make a diagnosis there
- To stop the ATM just press `CTRL+C`
- After a short time, `Manually Interrupted` is displayed and you can see on the display that the `ATM is turned off`
- Note: How to give the ATM an autostart function, you will learn later in chapter [`autostart`](/docs/guide/autostart.md)

display LightningATM

<img src="../pictures/edit_config_display_ATM_on.jpg" width="500">

display ATM turned off!

<img src="../pictures/edit_config_display_ATM_off.jpg" width="500">

---

#### [display](/docs/guide/display.md) ᐊ previous | next ᐅ [edit_app](/docs/guide/edit_app.md)



Expand Down
6 changes: 5 additions & 1 deletion docs/guide/information_and_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
- You can get more help in the Telegram group: [https://t.me/lightningatm_building](https://t.me/lightningatm_building)
- When making entries in the terminal window (CLI = Command Line Interface), it is best to copy and paste the commands:

> Copy the command to the clipboard with `STRG+C` and then point to the blinking cursor in the CLI window and press the right mouse button to paste the clipboard into the terminal window
> Copy the command to the clipboard with `STRG+C` and then point to the blinking cursor in the CLI window and press the right mouse button to paste the clipboard into the terminal window. (If it doesn't work, make the terminal window "aktiv" - with one left click on the window - befor you do the right click.)
- If you get the error "bash: $: command not found", you may have copied the dollar sign "$" in front of the command. Don't do that!
- When logging in via SSH, make sure to use the correct user `pi`. If you accidentally use `admin` or make a typo, you will not see an error, but the password will not be accepted
- You can change WiFi parameters with the command: `$ sudo nano /etc/wpa_supplicant/wpa_supplicant.conf`

---

#### [camera](/docs/guide/camera.md) ᐊ previous | next ᐅ [README](/README.md)
4 changes: 4 additions & 0 deletions docs/guide/sdcard_and_wifi.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ network={

- Note: When updating, you sometimes have to confirm with `y` or `q`
- If everything was installed, disconnect the power supply and log in again via SSH and the the new password

---

#### [wiring](/docs/guide/wiring.md) ᐊ previous | next ᐅ [display](/docs/guide/display.md)
25 changes: 15 additions & 10 deletions docs/guide/tmux_monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

This allows the terminal window to be split vertically into two parts to observe two processes at the same time.

###### Command overview for the terminal multiplexer (tmux)
###### Install tmux

```
CTRL + b -> % = split window
CTRL + b -> right or left arrow = change the window
CTRL + b -> CTRL + right or left arrow = move dividing line
CTRL + b -> d = back to single window
$ cd ~
$ sudo apt install tmux
```

###### Install tmux
###### Necessary commands for the terminal multiplexer (tmux)

```
$ cd ~
$ sudo apt install tmux
CTRL + b -> % = split window
CTRL + b -> right or left arrow = change the window
CTRL + b -> CTRL + right or left arrow = move dividing line
CTRL + b -> d = back to single window
```

###### Start and use tmux
Expand All @@ -35,7 +35,7 @@ $ tmux
$ ./app.py
```

- Note: If the ATM is already started (check with `$ sudo systemctl status LightningATM.service`), you should stop it (with `$ sudo systemctl stop LightningATM.service`) before starting it in manually (with `.app.py`) in the tmux terminal window. Otherwise strange phenomena may occur.
- Note: If you have already activated the autostart function, problems can arise if you start the app.py in the tmux window at the same time. Therefore, it is better to end the service for the tmux and activate it again later. See next chapter [`autostart`](/docs/guide/autostart.md).

###### Start `debug.log`

Expand All @@ -51,4 +51,9 @@ Example tmux window

![tmux window](../pictures/tmux_monitoring_terminal.png)

Left side you see the pulses. Right side you see the coins to it. 5, 2, 7, 2 => 50 Cent, 5 Cent, 2 Euro, 5 Cent
Two withdrawals were made here. Once 5 cents and once 1.60 euros (10 cents + 50 cents + 1 euro). Left side you see the pulses. Right side you see the coins to it. 2 = 5 Cent, 3 = 10 Cent, 5 = 50 Cent, 6 = 1 Euro. The final balance is 152048 satoshis.

---

#### [edit_app](/docs/guide/edit_app.md) ᐊ previous | next ᐅ [autostart](/docs/guide/autostart.md)

6 changes: 2 additions & 4 deletions docs/guide/voltage_converter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ voltage converter poti

<img src="../pictures/voltage_converter_poti.jpg" width="500">

calibrating voltage converter
![calibrating voltage converter](../pictures/voltage_converter_coin.jpg)


---

#### [README](/README.md) ᐊ previous | next ᐅ [coin_validator](/docs/guide/coin_validator.md)
4 changes: 4 additions & 0 deletions docs/guide/wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,9 @@ Pocket version wiring build-in with coin validator | Direct wiring,
:-------------------------:|:-------------------------:
![](../pictures/wiring_pv_build-in_complet.jpg) | ![](../pictures/wiring_direct_wiring.jpg)

---

#### [coin_validator](/docs/guide/coin_validator.md) ᐊ previous | next ᐅ [sdcard_and_wifi](/docs/guide/sdcard_and_wifi.md)



Binary file added docs/pictures/display_demo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/pictures/edit_app_terminal_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pictures/edit_config_display_ATM_off.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/pictures/tmux_monitoring_terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.