mirror of
https://gitlab.com/fabinfra/fabaccess/docs.git
synced 2024-11-19 21:47:57 +01:00
94 lines
4.2 KiB
Markdown
94 lines
4.2 KiB
Markdown
#FabAcess Step By Step#
|
|
|
|
This document provides a step by step Instruction on how to get FabAcess running. At the end of this description you will have:
|
|
- 2 Users registered to your system
|
|
- 2 Shellies registered to you system
|
|
- 1 Shelly configured as a door-opener
|
|
- 1 Shelly configured to identify if a machine is just switched on or realy running
|
|
- 2 QR-Codes generate to acess a machine
|
|
|
|
**Step 1 Installing the BFFH-Server**
|
|
|
|
there are multiple ways to install the BFFH server. This can bei either done via
|
|
- docker - see docker installation document
|
|
- installing from source - see installing from source documentation
|
|
- installing on Ubuntu for dummies
|
|
|
|
**Step 2 Installing the FabAccess App**
|
|
|
|
get the App via Apple Store or Google Apps.
|
|
|
|
**Step 3 Connect the App and the Server**
|
|
|
|
First you need to find the IP of the server. This can be done by typing
|
|
`ip a`
|
|
on the console of the system where the BFFH-Server is running. Use the adress listed under BROADCAST.
|
|
|
|
Start the server. If you are using the docker, this is done by using `docker-compose up -d`. If you compiled the server on your system this is done by entering `./diflouroborane -c examples/bffh.dhall --load examples` and then `./diflouroborane -c examples/bffh.dhall`. You will see some debug information, with probably some warnings.
|
|
|
|
Open the App. You will be asked to connect to a Host. Tap "DEMO HOST ADRESS" and change the IP to the IP of your Server, do not change the port number (everything after the IP. This should look like `192.168.1.15:59661`).
|
|
Tap "SELECT HOST".
|
|
|
|
You will be asked to sign in. For Version 0.2 only the Option "LOGIN WITH PASSWORD" ist available. Use `Testuser` and the passwort `secret` to log in.
|
|
|
|
You will find an overview of the installed machines including the option "SCAN QR-CODE".
|
|
Next step is setting up you machines so they can be switched on an off.
|
|
|
|
**Step 4 Prepare your Shellies**
|
|
|
|
as long as your Shelly has not been given the credentials for a WLAN, it will create an access point (AP) for configuration when connected to the supply voltage. This AP will appear in your list of WLAN.
|
|
Connect to this Shelly-AP and connect to `192.168.33.1` in your browser. A configuration page should appear.
|
|
If your Shelly is already connected to your WLAN, you must find the assigned IP-Adress (e.g. by looking into your router). Enter this IP Adress in your browser and you will get the configuration page.
|
|
|
|
Shelly MQTT Client setup
|
|
|
|
goto "Internet & Security" -> "Advanced - Developer Settings"
|
|
enable "MQTT"
|
|
enter the IP-Adress from your Server in the field "IP-Adress"
|
|
As we did not define MQTT credentials in mosquitto yet, no creadentials need to be filled in.
|
|
To find the "ID" of your Shelly activate "Use custom MQTT prefix" (but do not change it!). This should be somthing like:
|
|
`shelly1-123456789ABC` for a Shelly 1
|
|
`shelly1pm-123456` for a Shelly 1PM
|
|
note this ID for later
|
|
**- save**
|
|
**- re-check the settings!**
|
|
|
|
Shelly WLAN Client setup
|
|
goto "Internet & Security" -> "WIFI MODE - CLIENT"
|
|
Set WLAN Credentials
|
|
|
|
|
|
|
|
20. Configure Diflouroborane
|
|
Open the file "bffh.dhall" in the GUI Editor (just by double-clicking it)
|
|
Change `Shelly_123` to your Shelly name, e.g. `shelly1-123456789ABC` (**case sensitive!, dash sensitive!**) in "Link up machines to actors" and in "actors".
|
|
Change the third IP-adress under "listens" to the IP-adress of your computer.
|
|
**- save**
|
|
|
|
21. start Diflouroburane
|
|
change to the directory in the console where you checked for the ip-address
|
|
`cd BFFH/bffh/target/release`
|
|
load settings to Diflouroborane:
|
|
`./diflouroborane -c examples/bffh.dhall --load examples`
|
|
start Diflouroborane:
|
|
`./diflouroborane -c examples/bffh.dhall`
|
|
|
|
**Important**
|
|
every time you change the bffh.dhal you need to reload the settings (otherwise the App will not connect to the server on restart):
|
|
`./diflouroborane -c examples/bffh.dhall --load examples`
|
|
and restart start Diflouroborane:
|
|
`./diflouroborane -c examples/bffh.dhall`
|
|
|
|
Download the borepin APP as described previously
|
|
- start the App
|
|
- press: "Connect to new Server"
|
|
- press: Enter the IP of your computer in the "Host"-Field
|
|
- Enter your Username and Password.
|
|
|
|
To connect to the demo instance
|
|
- start the App
|
|
- press: "Connect to new Server"
|
|
- press: "Demo Host Address"
|
|
- User: "Testuser"
|
|
- Passw: "secret"
|