Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JamFfm authored Mar 21, 2020
1 parent f035cd4 commit 07ef7a4
Showing 1 changed file with 42 additions and 27 deletions.
69 changes: 42 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This addon only works with I2C connected LCD Displays.

## Installation

**Wireing:**
**Wiring:**

Display| PI
-------|--------------------
Expand All @@ -23,22 +23,25 @@ GND | Pin 6 GND

Ensure to activate the E2C connection in Raspi configuration.

**Softwareinstallation:**
**Software installation:**

Download and install this plugin via the CraftBeerPi user interface. It is called LCDDisplay.

Download and install this plugin via
the CraftBeerPi user interface. It is called LCDDisplay.
After that a reboot is necessary.

## Configuration

At least configure your i2c adress in the parameters menue. Some other
parameters of the LCD can be changed in the __init__.py file in the
/home/pi/craftbeerpi3/modules/plugins/LCDDisplay folder.
At least configure your i2c address in the parameters menu. Some other
parameters of the LCD can be changed in the

__init__.py

file in the /home/pi/craftbeerpi3/modules/plugins/LCDDisplay folder.


There are different modes:

**Defaultdisplay**
**Default display**
--------------

If no brewing process is running the LCD Display will show
Expand All @@ -51,44 +54,54 @@ If no brewing process is running the LCD Display will show
**Multidisplay mode**
-----------------

- The script will loop thru your kettles and display the target and current temperatur.
- The script will loop thou your kettles and display the target and current temperature.
- If heater is on, a beerglas symbol will appear in the first row on the right side (not flashing).
- When target-temperature is reached it displayes the remaining time of the step (rest) too.
- When target-temperature is reached it displays the remaining time of the step (rest) too.

**Single mode**
-----------

- Only displayes one kettle but reacts a little bit faster on temperature changes.
- It displayes the remaining time of the step (rest) when target temperature is reached.
- Only displays one kettle but reacts a little bit faster on temperature changes.
- It displays the remaining time of the step (rest) when target temperature is reached.
- When the heater is "on" a small beerglas is flashing on/off in the first row on the right side.

**Fermenter mode**
--------------
- Pretty much the same as multidisplay for all fermenter.
- Displayes the brewname, fermentername, target-temperature, current-temperature of each fermenter.
- When the heater or cooler of the fermenter is on it will show a symbol.
- Displays the brew-name, fermenter-name, target-temperature, current-temperature of each fermenter.
- If the heater or cooler of the fermenter is on it will show a symbol.
A beerglas detects heater is on, * means cooler in on.
- The remaining time for each fermenter is shown like in weeks, days, hours.
- Fermenter mode starts when a fermenter-step of any of the fermenters is starting and no brewing step is running(most likely)
- Fermenter mode starts when a fermenter-step of any of the fermenter is starting and no brewing step is running(most likely)

Parameter
---------

There are several parameter to change in the **CBPi-parameter** menue:
There are several parameter to change in the **CBPi-parameter** menu:


**LCD_Adress:**
This is the adress of the LCD modul. You can detect it by
**LCD_Address:**
This is the address of the LCD modul. You can detect it by
using the following command in the commandbox of the Raspi:
- sudo i2cdetect -y 1
or
- sudo i2cdetect -y 0.
Default is 0x27.



**LCD_Charactermap:**
Changes value between A00 and A02. This is a character map build in by factory into the LCD.
Most likely you get a LCD with A00 when you by it in China. A00 has got most of the European letters and a lot
of Asia letters. For germans the ÄÖÜß is missing in A00. In A02 there are more European letters incl. ÄÖÜß.
Therefore the addon distinguish between the charmaps.
In case A00 it substitutes ÄÜÖß with custom made symbols which represent these letters.
In case A02 the addon skips substitution. If you notice strange letters try to change this parameter.
Default is "A00".


**LCD_Multidisplay:**
Changes between the 2 modes. "on" means the Multidisplaymode is on.
"off" means singledisplaymode is on. Default is "on".
Changes between the 2 modes. "on" means the Multi-display mode is on.
"off" means single-display mode is on. Default is "on".


**LCD_Refresh:**
Expand All @@ -101,7 +114,6 @@ Here you can change the kettle to be displayed in single mode. The number is the
kettles starting with 1. Default is kettle 1 (probably the first kettle which was defined in hardware).



## Hints

- Changing a LCD_xxxx parameter in the parameters menue or any
Expand All @@ -110,25 +122,28 @@ file in LCDDisplay folder usually requires a reboot.
- A new fermenter should have a target temperature and at least one step defined.
- It maybe necessary to restart craftbeerpi after adding a new fermenter.

- If the address is right but you still can not see letters displayed:
- If the LCD address (eg. 0x27) is right but you still can not see letters displayed:
- try to adjust contrast by the screw on the back of the LCD Hardware (I2C Modul)
- be shure to provide the LCD hardware with the right ammount of voltage (mostly 5V or 3.3V)
- use a strong powersuppy. If you notice LCD fading a bit there is a lack of current.
- use proper connections. Soldering the wires is best for connection. Bad connection can also result in fading the LCD.


## Known Problems
The LCD hardware does not like temperature below 0°C (32°F). It becomes slow and can be damaged like brightness is no more homogen throughout the hole LCD area.
The LCD hardware does not like temperature below 0°C (32°F).
It becomes slow and can be damaged like brightness is no more homogen throughout the hole LCD area.

Does not work with stretch: if you start a step LCD will stopp running.
Does not work with stretch: if you start a step LCD will stop running.


## Questions
Questions can be posed in the Craftbeerpi Usergroup in Facebook or in the repository.
Questions can be posed in the Craftbeerpi user group in Facebook or in the repository.


## Fixed Issues
- Now the °C or F is displaed like in CBPi parameters
- If there is a missing Kettle or Fermenter no more faults are thrown.
- Sometimes it lastes a long time till the fermenterstep starts running.
- When CBPi3 Mesh Steps are active and you restart CBPi3 the display will show nothing. It will at least show the startscreen. Stop and restart the Mesh steps is still nessesary tho show active step.
- When CBPi3 Mesh Steps are active and you restart CBPi3 the display will show nothing.
It will at least show the startscreen. Stop and restart the Mesh steps is still nessesary tho show active step.
- Not displaying ÄÜÖß

0 comments on commit 07ef7a4

Please sign in to comment.