Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
theyosh committed May 10, 2024
1 parent 90e8395 commit 29f091f
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 72 deletions.
58 changes: 0 additions & 58 deletions .github/workflows/docker-image.yml

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ build:
--platform linux/arm/v7 \
-t $(IMAGE):$(VERSION) \
--build-arg GITHUB_SHA=${GITHUB_SHA} \
-f Dockerfile \
-f Dockerfile.buster \
.

push:
Expand All @@ -24,7 +24,7 @@ push:
--platform linux/arm/v7 \
-t $(IMAGE):$(VERSION) \
--build-arg GITHUB_SHA=${GITHUB_SHA} \
-f Dockerfile \
-f Dockerfile.buster \
--push \
.

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TerrariumPI 4.8.4
# TerrariumPI 4.9.0

![Latest release](https://img.shields.io/github/v/release/theyosh/terrariumpi?label=Latest%20release)
![GitHub Release Date](https://img.shields.io/github/release-date/theyosh/TerrariumPI)
Expand Down Expand Up @@ -186,6 +186,7 @@ This software requires a Raspberry Pi and some extra hardware in order to run an
- Pi 2 (Should work/At own risk/limited support)
- Pi 3 (Works/full support)
- Pi 4 (Works/full support)
- Pi 5 **does NOT work** (Due to changes in the hardware on the Pi)
- Power relay board
- USB versions (Serial and Bitbang)
- GPIO versions
Expand Down
2 changes: 1 addition & 1 deletion docs/_posts/2022-12-30-release_4.6.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ image:
## Release 4.6.1 - Happy new year !!

![Fireworks](/assets/img/Fireworks.gif){: .right width="100" }
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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions docs/_posts/2024-03-21-release_4.8.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ image:

### Settle time bug

![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.
![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.

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

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

### GUI updates

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 ;)
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:

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.

Expand Down
24 changes: 17 additions & 7 deletions docs/_posts/2024-05-12-release_4.9.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Release TerrariumPI v 4.9.0
date: 2024-05-12 12:00:00 +0100
date: 2024-04-12 12:00:00 +0100
categories: [Website, News]
tags: [release, "4.9.0"]

Expand All @@ -16,15 +16,15 @@ image:

![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.

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 :(
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:

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.

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!

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.

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

### GUI updates

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

#### Unsplash support

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.
![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.

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

### Docker

![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.

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.

For now, do not use Bookworm as host machine for running the docker images. That will probably not work.

Also Raspberry PI 5 **not** supported! This is due to different hardware design.

### Bookworm adaptation

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.
Expand All @@ -48,14 +58,14 @@ And finally a new Bluetooth library is needed due to the Python version. But tha

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

### Docker

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.
**Docker** is not supported on Bookworm yet. You cannot run a TerrariumPI docker image on a Bookworm OS.

### Logging

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.

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.

### Bugs

A small bug using weather data for main lights area is fixed. [#911](https://github.com/theyosh/TerrariumPI/issues/911)
Expand Down
2 changes: 1 addition & 1 deletion docs/_tabs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Also **64bit is not supported** due to missing mmal code which is needed for the
### Creating SD Card

![Raspberry PI Imager](/assets/img/RPI_Imager.webp){: .right width="200" }
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.
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.

![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.

Expand Down
Binary file added docs/assets/img/UnsplashLogo.webp
Binary file not shown.

0 comments on commit 29f091f

Please sign in to comment.