Skip to content

Commit 29f091f

Browse files
committed
Documentation updates
1 parent 90e8395 commit 29f091f

File tree

8 files changed

+25
-72
lines changed

8 files changed

+25
-72
lines changed

.github/workflows/docker-image.yml

Lines changed: 0 additions & 58 deletions
This file was deleted.

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ build:
1414
--platform linux/arm/v7 \
1515
-t $(IMAGE):$(VERSION) \
1616
--build-arg GITHUB_SHA=${GITHUB_SHA} \
17-
-f Dockerfile \
17+
-f Dockerfile.buster \
1818
.
1919

2020
push:
@@ -24,7 +24,7 @@ push:
2424
--platform linux/arm/v7 \
2525
-t $(IMAGE):$(VERSION) \
2626
--build-arg GITHUB_SHA=${GITHUB_SHA} \
27-
-f Dockerfile \
27+
-f Dockerfile.buster \
2828
--push \
2929
.
3030

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TerrariumPI 4.8.4
1+
# TerrariumPI 4.9.0
22

33
![Latest release](https://img.shields.io/github/v/release/theyosh/terrariumpi?label=Latest%20release)
44
![GitHub Release Date](https://img.shields.io/github/release-date/theyosh/TerrariumPI)
@@ -186,6 +186,7 @@ This software requires a Raspberry Pi and some extra hardware in order to run an
186186
- Pi 2 (Should work/At own risk/limited support)
187187
- Pi 3 (Works/full support)
188188
- Pi 4 (Works/full support)
189+
- Pi 5 **does NOT work** (Due to changes in the hardware on the Pi)
189190
- Power relay board
190191
- USB versions (Serial and Bitbang)
191192
- GPIO versions

docs/_posts/2022-12-30-release_4.6.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ image:
1313
## Release 4.6.1 - Happy new year !!
1414

1515
![Fireworks](/assets/img/Fireworks.gif){: .right width="100" }
16-
This is a release which fixes a lot of the new GUI issues. Apparently christmas came to early ;). But with this release, all the annoying bugs are hopefully fixed. Even when you are now running 4.6.0 without issues, it is wise to upgrade to 4.6.1. Most issues arises when you start to edit areas or hardware in the GUi.
16+
This is a release which fixes a lot of the new GUI issues. Apparently christmas came to early :wink:. But with this release, all the annoying bugs are hopefully fixed. Even when you are now running 4.6.0 without issues, it is wise to upgrade to 4.6.1. Most issues arises when you start to edit areas or hardware in the GUi.
1717

1818
[Get the new version here](https://github.com/theyosh/TerrariumPI/releases/tag/4.6.1).
1919

docs/_posts/2024-03-21-release_4.8.4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ image:
1414

1515
### Settle time bug
1616

17-
![Homer Simpsons: DOH!](/assets/img/doh.webp){: .right .invert width="150" }Apparently there was a bug in the code for many, many years :(. The settle time value was calculated from the time the relay was toggled on. But when the relay on duration is higher than the settle time value, the settle time was useless.
17+
![Homer Simpsons: DOH!](/assets/img/doh.webp){: .right .invert width="150" }Apparently there was a bug in the code for many, many years :disappointed:. The settle time value was calculated from the time the relay was toggled on. But when the relay on duration is higher than the settle time value, the settle time was useless.
1818

1919
So, the time **on** is 5 minutes, and the settle time is set to 4 minutes, it will never settle. Which is totally wrong.
2020

@@ -32,7 +32,7 @@ For Bookworm OS, a new bluepy module is needed. This module could be not 100% co
3232

3333
### GUI updates
3434

35-
A big thanks to [@manolof](https://github.com/manolof) for updating the gui so that it will render better on a mobile device. Apparently he is a better frontend developer than me ;)
35+
A big thanks to [@manolof](https://github.com/manolof) for updating the gui so that it will render better on a mobile device. Apparently he is a better frontend developer than me :wink:
3636

3737
And the sort order of enclosures and areas is changed. Now it can sort based on number when the names are starting with numbers. So then it will sort 1..4-10 etc. This applies to enclosers and areas. With one exception. For area sorting, the [main light area]({% link _tabs/setup.md %}#main-lights) is always shown first. As this can control the other areas below.
3838

docs/_posts/2024-05-12-release_4.9.0.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Release TerrariumPI v 4.9.0
3-
date: 2024-05-12 12:00:00 +0100
3+
date: 2024-04-12 12:00:00 +0100
44
categories: [Website, News]
55
tags: [release, "4.9.0"]
66

@@ -16,15 +16,15 @@ image:
1616

1717
![Road Runner](/assets/img/roadrunner.webp){: .right .invert width="150" }When TerrariumPI is running for a couple or years, you will get a lot of relay data which it used for the total power and water usage. After 7 years, it took about 15 seconds each time it was calculated. Which is half the time of the engine run time. So that is not good.
1818

19-
But also, it takes a full CPU so all other processes needs to wait. Which is also horrible. And can give a cascading effect where the system can never keep up anymore. Python cannot use multiple CPU's :(
19+
But also, it takes a full CPU so all other processes needs to wait. Which is also horrible. And can give a cascading effect where the system can never keep up anymore. Python cannot use multiple CPUs :frowning_face:
2020

2121
And the process is not only called during updates, but also when a relay changed state, or when a new user connects to the web GUI. That all makes it going very slow and give timeouts.
2222

2323
So now the totals are cached and updated once an hour. Or when a relay goes **off**. And that is enough to still have correct information. But this will give a lot of processing power back to the rest of the system. And the GUI is loading even faster now! Yeah!
2424

2525
Also some long running processes are now running on the background, so the main engine does not have to wait for that anymore. This will also speed up the processing.
2626

27-
It looks like this should **improve the speed by 40%** or **reduce the load by 40%**. Depends how you look at it ;)
27+
It looks like this should **improve the speed by 40%** or **reduce the load by 40%**. Depends how you look at it :grin:
2828

2929
### GUI updates
3030

@@ -34,10 +34,20 @@ Also the relay graphs are now again full selected period. By default that is 24
3434

3535
#### Unsplash support
3636

37-
It is now possible to have a nice background from Unsplash. This needs a free account at Unsplash. With your account you can create a free demo app at Unsplash. When that is done, you enter the Access Key in the GUI settings page with keywords for the background image. By default pictures of green forests are shown.
37+
![Unsplash Logo](/assets/img/UnsplashLogo.webp){: .left .invert width="150" }It is now possible to have a nice background from [Unsplash](https://unsplash.com/). This needs a free account at Unsplash. With your account you can create a free demo app at Unsplash. When that is done, you enter the Access Key in the GUI settings page with keywords for the background image. By default pictures of green forests are shown.
3838

3939
Read [this FAQ]({% link _faq/unsplash.md %}) how to setup the Unsplash background.
4040

41+
### Docker
42+
43+
![Docker Logo](/assets/img/DockerLogo.webp){: .left .invert width="150" }The docker build has been changed to support a docker image per Raspberry PI OS. So now there is a buster and a bullseye docker image. Bookworm OS is problematic, and will take more time to fix.
44+
45+
The new image tags will be `x.y.z-os` where `x.y.z` is the actual version and `os` is either buster or bullseye. The tag `latest` is referring to the latest `buster` image as that is the same image as being used until now.
46+
47+
For now, do not use Bookworm as host machine for running the docker images. That will probably not work.
48+
49+
Also Raspberry PI 5 **not** supported! This is due to different hardware design.
50+
4151
### Bookworm adaptation
4252

4353
There is more support for Bookworm OS. It is still not fully supported. As it takes time to figure some strange issues out with the webcams. So it will install on Bookworm, but it can happen that webcams will not work. This is due to an OpenCV and different way of capturing the Raspberry PI camera.
@@ -48,14 +58,14 @@ And finally a new Bluetooth library is needed due to the Python version. But tha
4858

4959
But the installer should now detect the correct OS and install the correct libraries and settings per OS.
5060

51-
### Docker
52-
53-
In the future there will be a docker image per OS. This is done as the docker image for Bookworm is harder to make, and takes a lot more space. In order to keep the docker images as small as possible, they will be split up per OS in the near future.
61+
**Docker** is not supported on Bookworm yet. You cannot run a TerrariumPI docker image on a Bookworm OS.
5462

5563
### Logging
5664

5765
The logging is changed a lot so it is now even more informative. And fixed a security issue where for some errors sensitive data is logged. This is now fixed, so no sensitive data should be logged.
5866

67+
And a number of error messages are changed to warning. And some warning/error messages where logged multiple times, which is a bit to verbose. This has been reduced.
68+
5969
### Bugs
6070

6171
A small bug using weather data for main lights area is fixed. [#911](https://github.com/theyosh/TerrariumPI/issues/911)

docs/_tabs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Also **64bit is not supported** due to missing mmal code which is needed for the
2222
### Creating SD Card
2323

2424
![Raspberry PI Imager](/assets/img/RPI_Imager.webp){: .right width="200" }
25-
Download and instal the [Raspberry Pi Imager](https://www.raspberrypi.org/software/) to prepare your SD card. Make sure you have a SD card of at least 4GB of size. Bigger is better :) Make sure you select **Raspberry Pi OS Lite (legacy)** from the other Raspberry Pi OS images.
25+
Download and instal the [Raspberry Pi Imager](https://www.raspberrypi.org/software/) to prepare your SD card. Make sure you have a SD card of at least 4GB of size. Bigger is better :smile: Make sure you select **Raspberry Pi OS Lite (legacy)** from the other Raspberry Pi OS images.
2626

2727
![Raspberry PI Imager settings icon](/assets/img/RPI_Imager_settings.webp){: .left width="50"}In order to enable SSH, Wifi and other settings, click on the settings icon in the lower right corner. Here you enter your Wifi settings, pi password etc. Use this to install the Raspberry PI headless. Add the SD card in the Raspberry PI and withing a minute you should have a running Raspberry PI.
2828

docs/assets/img/UnsplashLogo.webp

2.72 KB
Binary file not shown.

0 commit comments

Comments
 (0)