Skip to content
master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time

README.md

TerrariumPI 3.9.8

Translation status FOSSA Status

Software for cheap home automation of your reptile terrarium or any other enclosed environment. With this software you are able to control for example a terrarium so that the temperature and humidity is of a constant value. Controlling the temperature can be done with heat lights, external heating or cooling system. As long as there is one temperature sensor available the software is able to keep a constant temperature.

For humidity control there is support for a spraying system. The sprayer can be configured to spray for an X amount of seconds and there is a minumal period between two spray actions. Use at least one humitidy sensors to get a constant humidity value. In order to lower the humidity you can add a dehumidifier.

The software is that flexible that there is no limit in amount of sensors, relay boards or door sensors. The usage can be endless. All power switches have support for timers to trigger based on a time pattern.

If you are using this software for your animals or plants, please post some pictures

It can either run on Python 2.7 or Python 3.5+. Prefered is Python3

Think off:

  • Terrarium (wet or dry)
  • Aquarium
  • Tanks with animals or plants
  • Growhouse

And all this is controlled with a nice webinterface based on Gentelella a Bootstrap 3 template.

Table of Contents

  1. Features
  2. Translations
  3. Installation
  4. Updating
  5. Hardware
    1. GPIO numbering
    2. New hardware
  6. Remote data
  7. Screenshots
  8. Testing
  9. About

Features

  • Controlling electronic devices like lights, sprayers, heating, cooling, water pump equipment etc
  • Support for dimming electronic devices
    • Manual dimming through web interface
    • Predefined on and off dimming durations
    • Predefined on and off dimming percentages
    • Predefined dimming steps for environment system (heater and cooler)
  • Support for timmers in power switches and environment #72
    • Predefined start and stop times based on timer or weather
    • Predefined on and off durations in minutes
  • Support for Energenie USB, LAN and RF power switches EG-PM(s)2
  • Support for WeMo Wifi power switches
  • Support for Meross MSS425E Power Switches (Requires Python 3 setup)
  • Support for Sonoff remote power devices
  • Support for multiple type of sensors
    • Temperature
    • Humidity
    • Moisture
    • Conductivity
    • Distance
    • pH
    • Light intensity
    • UV A and B
    • Fertility
    • Volume
  • Support for webcams and native Raspberry Pi cam out of the box
    • Raspberry Pi cam can be streamed live with 6 seconds delay
    • Archiving images based on motion or time interval
  • Support for analog devices through a MCP3008
    • Support for PH probe SKU SEN0161
  • Support for MiFlora Bluetooth sensors
  • Open door detection. This can be used in different environment parts
  • Total power and water usage for costs calculation
  • Lights control based on sun rise and sun set or timers
  • Rain control based on humidity sensors and timers
  • Temperature control based on temperature sensors or timers
    • Variable day and night difference for min and max temperature
  • Watertank level control based on ultrasonic sound range sensors or volume sensors
  • Weather forecast from external source for lighting schema
  • Temperatures in Celsius or Fahrenheit
  • Distances in centimetres or inches
  • Alarm detections
  • Audio support through interal audio jack or USB soundcards #42
    • Create playlists (loop and repeat)
    • Volume controle in the webinterface
    • Uploading audio files through webinterface
    • Audio meta data support (mediainfo)
  • Remote temperature and humidity sensors through HTTP(S) JSON API's. JSON Data format can be found on Remote data wiki.
  • Display support
    • LCD 16x2 or 20x4 screens either through I2C or Serial
    • OLED based on SSD1306
  • Calendar system when hardware is replacement and when new hardware needs to be installed
  • Notifications system. Custom messages for custom actions with use of variables in the messages
    • Get notifications through
      • Email
      • Twitter (DM)
      • Pushover
      • Telegram bot
      • Display
      • Webhooks
    • Notifications for
      • Environment part low and high alarm
      • Sensor high and low measurements
      • Power switch toggle on and off
      • Open and close doors
      • System error and warning messages

It is currently controling my reptile terrarium for more then three years! And my Madagascar Day Gecko is very happy with it!

Translations

The software has support for the following languages:

Translation status

Your language not in the list or not up to date? Create your own language translation Translation status

Installation

The installation expects a Pi with working network and ssh. It is tested with Raspberry Pi OS Lite. For now the Full version is not working somehow.... So use the lite image! A new installation will take about 45 minutes. This is due to manually compiling python modules for the latest versions. Upgrades will go much faster.

  1. Get a working Raspberry Pi and login as user 'pi'
    ssh pi@[raspberry_ip]
  2. Install git
    sudo apt -y install git
  3. Clone this repository and submodules!
    git clone --recursive --depth 1 https://github.com/theyosh/TerrariumPI.git
  4. Enter the new TerrariumPI folder
    cd TerrariumPI
  5. Run the installer script and wait
    sudo ./install.sh 3
  6. Reboot Raspberry PI to get all the needed modules loaded
    sudo reboot
  7. Go to the webinterface at http://[raspberry_ip]:8090

All needed options and modules are setup by the installer script. This means that I2C and 1Wire overlay are enabled by default.

Make sure that your Pi is secured when you put it to the Internet. Would be a shame if TerrariumPI gets next fictum of 'A smart fish tank left a casino vulnerable to hackers' :P

Updating

This updating is based on that the software is installed with the steps in the Installation above. When updating between release versions it will take more time due to database updates and cleanups. This can be seen in the logfile.

  1. Get a working Raspberry Pi and login as user 'pi'
    ssh pi@[raspberry_ip]
  2. Enter the TerrariumPI folder
    cd TerrariumPI
  3. Update the new code with git
    git pull
  4. Re-run the installation script in order to update software dependencies
    sudo ./install.sh 3
  5. Restart TerrariumPI according to: https://github.com/theyosh/TerrariumPI/wiki/FAQ#how-to-restart-terrariumpi

Now clear your browser cache and reload the webinterface. A brand new version should be running.

Hardware

This software requires a Raspberry Pi and some extra hardware in order to run and work. The bare minimun and tested hardware is

  • Raspberry PI with at least 4GB SD card
    • Pi 2
    • Pi 3
    • Zero (At own risk/no support)
  • Power relay board
    • USB versions (Serial and Bitbang)
    • GPIO versions
    • PWM Dimmer versions
  • Temperature/humdity/ultrasonic/PH sensors DHT11, DHT22, AM2303, DS1820, HIH4000, HC-SR04, SEN0161, etc through

Full list of supported hardware

GPIO numbering

All hardware that connects to the GPIO pins use Physical GPIO numbering (1 - 40). The software will translate it to BCM if needed for a supported device or sensor. More information about GPIO pin numbering

For the analog devices use numbers of the channel on the analog device which is from 0 to 7 (8 channels). Also the software expect the analog MCP3008 on GPIO ports 19,21,23,24 physical (default). More information about GPIO pin numbering

New hardware

If there is some other hardware which is not working with TerrariumPI, open an issue on Github and we will try to support it. Raspberry Pi Zero is not tested.

Remote data

It is possible to use external sensor data that is available through HTTP(S) in JSON format. This way you can combine multiple Raspberry Pi's with TerrariumPI running to one single system. By using multiple Rapsberry PI's you can cover a bigger area. But there are limitations.

Currently it is READONLY. So you can read out remote sensors and switches but you cannot control the remote switches. But this way you can combine the power swiches total costs and power usage.

more information is here: Remote data wiki

Screenshots

(made on a very big screen :P )

Dashboard

TerrariumPI 2.5 Dashboard screenshot

Sensors

TerrariumPI 2.5 Sensors settings screenshot

Adding sensors

TerrariumPI 2.5 Sensors settings screenshot adding a new sensor

Power switches

TerrariumPI 2.5 Power switches settings screenshot

Environment setup

TerrariumPI 2.5 Environment setup screenshot

System settings

TerrariumPI 2.5 System setup screenshot

MOTD (Message Of The Day)

TerrariumPI 2.5 MOTD screenshot

More screenshots can be found here

Testing

Free tested with BrowserStack for opensource BrowserStack

About

A live version is running at: https://terrarium.theyosh.nl/index.html. Go to 'Help' menu for more information about used hardware, software and how to setup.

License

FOSSA Status

You can’t perform that action at this time.