Skip to content

Commit

Permalink
v1.4.1pre
Browse files Browse the repository at this point in the history
Unpin Raspi-Sump to a specific version of hcsr04sensor in setup.py
Update install  instructions
  • Loading branch information
alaudet committed Feb 19, 2022
1 parent 3f9d78d commit 23f9135
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 59 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,37 +21,25 @@ Raspian 9 (Stretch) support will be discontinued in June 2022. Please upgrade t
Discuss and get support from other users. Email ([email protected]) for an invite link.


# Installing with Pip
# Install Dependencies

sudo apt install python3-pip python3-rpi.gpio python3-matplotlib

# Install Raspi-Sump

Pip installs default to Wheels which omits some folder setup in setup.py.
Always use the '--no-binary :all:' option when installing or upgrading Raspi-Sump with pip.

sudo pip3 install --no-binary :all: raspisump


# QUICK INSTALL


Install the pip package manager (if not present on your pi).

sudo apt-get install python3-pip


Install Raspi-Sump.

sudo pip3 install --no-binary :all: raspisump
# Upgrading Raspi-Sump

Upgrading an existing version


sudo pip3 install -U --no-binary :all: raspisump

This will also install the [HCSR04sensor](https://github.com/alaudet/hcsr04sensor) and RPi.GPIO modules if not present on your Pi.

If you want to use charts install maplotlib.

sudo apt-get install python3-matplotlib
This will also install the [HCSR04sensor](https://github.com/alaudet/hcsr04sensor)


Read the configuration docs copied during setup on your pi at the following location;
Expand Down
4 changes: 4 additions & 0 deletions changelog
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Raspi-Sump Changelog
====================

Version 1.4.1
- Unpinned Raspi-Sump to a specific version of hcsr04sensor in setup.py
- Updated install instructions.

Version 1.4
- Add on demand email testing with command 'emailtest'

Expand Down
47 changes: 8 additions & 39 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,47 +17,18 @@ Raspbian OS 9 (Stretch) - Support ends June 30, 2022
Install Dependencies
====================

1) Check to ensure that Python3 is installed on Raspbian Linux.

python3

You should see the interpreter open and the version of Python3.

To exit the interpreter;

quit()


To install Python3 on your pi; (first command is optional and updates your
repositories)

sudo apt-get update && sudo apt-get -y upgrade
sudo apt-get -y install python3 python3-dev


2) If you want to create graphs of sump pit activity install Matplotlib and Numpy
as follows;

sudo apt-get install python3-matplotlib


Matplotlib should install Numpy as a dependency but if you need to install
it manually;

sudo apt-get install python3-numpy


3) Install PIP


sudo apt-get install python3-pip
Install Pip, RPi.GPIO and Matplotlib

sudo apt update && sudo apt -y upgrade
sudo apt install python3-pip python3-rpi.gpio python3-matplotlib

RPi.GPIO is the library that controls the sensor. Matplotlib is used to generate charts.
The Pip package manager is required to install Raspi-Sump in the next step.

Install Raspi-Sump
==================

The following will automatically install hcsr04sensor and RPi.GPIO if it is not already
The following will automatically install hcsr04sensor if it is not already
installed on your Pi.

sudo pip3 install --no-binary :all: raspisump
Expand Down Expand Up @@ -146,7 +117,7 @@ To run raspisump at 1 minute intervals enter the following line in crontab as fo
(See cron documentation for questions on configuring crontab)


4) To monitor the log file in the csv folder while raspi-sump is running;
1) To monitor the log file in the csv folder while raspi-sump is running;

tail -f 'csvlogfilename'

Expand Down Expand Up @@ -357,6 +328,4 @@ from the link in the web page.
You are only limited by your own imagination on how to view your charts. I
have setup a bash script that automatically creates the graph on my Pi and
moves it to an offsite webserver where I can view today's readouts and
historical data.

Example: https://raspisump.linuxnorth.org
historical data.
Binary file modified docs/install.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from setuptools import setup
import os

version = "1.4"
version = "1.4.1pre"

homedir = "/home/pi/raspi-sump/"

Expand Down Expand Up @@ -59,7 +59,7 @@
packages=["raspisump"],
scripts=raspi_sump_files,
data_files=add_files,
install_requires=["hcsr04sensor>=1.6"],
install_requires=["hcsr04sensor"],
)

if os.path.isdir(homedir):
Expand Down

0 comments on commit 23f9135

Please sign in to comment.