Skip to content

Commit

Permalink
Documentation: This and that
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Apr 14, 2024
1 parent 23ad416 commit db59c8a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ coverage.xml
*.egg-info
*.pyc
__pycache__
/dist
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,12 @@ We recommend to install the program into a Python virtualenv.
```shell
python3 -m venv .venv
source .venv/bin/activate
pip install 'ds18b20-datalogger @ git+https://github.com/hiveeyes/ds18b20-datalogger.git'
pip install --upgrade ds18b20-datalogger
```

In this spirit, you keep the installation separate from your system Python, so
you can easily nuke it and start from scratch in case anything goes south.

Prerequisites: This program needs the `paho-mqtt` package.
https://pypi.org/project/paho-mqtt/#installation


## Operations

Expand Down
9 changes: 4 additions & 5 deletions ds18b20_datalogger/core.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
#!/usr/bin/env python
"""
Requires:
paho-mqtt in a venv: https://pypi.org/project/paho-mqtt/#installation
insert your own sensor addresses (see below line 125+)
your MQTT connection settings and credentials (line 65+)
Configure:
- Insert your own sensor addresses (read_ds18b20_sensor_matrix).
- Adjust MQTT connection settings and credentials (send_measurement_mqtt).
Recommended:
Start:
```
ssh to your pi
screen
Expand Down

0 comments on commit db59c8a

Please sign in to comment.