Skip to content

JeffLabonte/garden-gateway

Folders and files

NameName
Last commit message
Last commit date
Apr 17, 2023
Apr 17, 2023
Sep 1, 2022
Jul 14, 2022
Feb 27, 2023
Jun 7, 2023
Feb 27, 2023
Feb 27, 2023
Jul 14, 2022
Jan 22, 2023
Jul 8, 2022
Jul 13, 2022
Oct 2, 2023
Sep 6, 2023
Oct 14, 2021
Apr 17, 2023
Jan 9, 2023
Feb 13, 2023
Jul 8, 2022
Jan 1, 2023
Jun 6, 2022
Feb 13, 2023

garden-gateway

CI codecov

Please note this is still a WORK IN PROGRESS project. It is under heavy development, so a lot will change. You might have to reset your configurations once in a while until I have a 100% working prototype at home and documented my setup.

Getting Started

This project currently runs only on Raspberry PIs.

It was tested on Debian Buster (Raspberry Pi OS).

Installing the dependencies to Run code

If you are running Ubuntu or any derivates, you can run make setup-ubuntu to install the dependencies for you.

If you are running ArchLinux or any derivates, you can run make setup-arch

If you run NixOS or Nix, you can run nix-shell and enjoy!

Create .env file

  1. Run make copy_template
  2. Edit .env using your favorite editor
  3. Update DATABASE_URL

Usage

CLI

cargo run help
Garden Gateway CLI
CLI to interact with Garden Gateway code.

USAGE:
    gateway <SUBCOMMAND>

    OPTIONS:
        -h, --help    Print help information

        SUBCOMMANDS:
            config
            help        Print this message or the help of the given subcommand(s)
            import
            run
            schedule
            test

Integrated Sensors/Devices

  1. IoT Relay

Features

Status Feature
List Configurations
Integrate IoT Relay
Import Schedules from JSON file
Integrate custom board to switch Pump**
Import Configurations from JSON file

**Board using BC517 transistor for the submersible water pump.