Chaleira FCUP Documentation

This is the repository for the FCUP Chaleira project.

Each of the folders contains a separate part of the work which should be installed on the proper device of the project.

For more instructions check the corresponding folders.

Codebase

This repository contains all the code for the different elements of the architecture.

Detailed documentation about every element can be found inside of their respective folders.

• Arduino - Code referring to the arduino implementation
• Android - Source code of the Android application
• RaspberryPi - NodeJS server that should run on the Raspberry
• Test Page - Test page used for tests, info, etc It served as a mock for RaspberryPi during initial development.

Firebase Rules

The project assumes that a firebase realtime database exists, and it is configured with the following rules:

{
    "rules": {
        ".read": true,
            ".write": true,
            "users": {
                "$uid": {
                    ".write": "auth != null && auth.uid == $uid",
                }
            },
        "kettle": {
            ".write": "auth != null && auth.uid == '<UUID>'"
        },
        "reservations": {
            ".write": "auth != null"
        },
        "user-reservations": {
            ".write": "auth != null && auth.uid == '<UUID>'",
            "$uid": {
                ".write": "auth != null && auth.uid == $uid || auth.uid == '<UUID>'"
            }
        }
    }
}

IMPORTANT: <UUID> is the UUID of our admin user, in your case you should create your own user and replace the UUID there.