FabInfra-Mirror/fabfire_adapter
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/fabfire_adapter.git synced 2025-03-12 14:51:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README to reflect installation notes and general things

Browse Source
This commit is contained in:
Mario Voigt 2025-02-14 14:00:03 +01:00
parent ab389ac2ed
commit 4e6674cd61
1 changed files with 49 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,30 +1,64 @@
FabFire Adapter FabFire Adapter
=== ===
The FabFire adapter translates mqtt messages from the reader hardware to api calls to bffhd.
# Usage The FabFire adapter translates MQTT messages from the FabReader hardware to API calls to bffhd.
## Configuration in `config.toml`
# Installation
## With python3-venv
Easy, native installation without overhead is possible with python3 virtual environment:
```shell
cd /opt/fabinfra/adapters/
git clone https://gitlab.com/fabinfra/fabaccess/fabfire_adapter.git --recursive
cd fabfire_adapter/
python3 -m venv env
. env/bin/activate
pip3 install -r requirements.txt
```
## With the Dockerfile and Podman
You can also install the fabfire adapter using Docker or Podman:
```shell
podman build -f Dockerfile -t fabinfra/fabfire_adapter
podman run localhost/fabinfra/fabfire_adapter:latest
#cleanup if required:
podman system prune
```
# Configuration
Edit the config file example provided in `config/config.toml`
1. Set `hostname` and `port` for your MQTT Broker and bffhd instance 1. Set `hostname` and `port` for your MQTT Broker and bffhd instance
2. Add your readers to the `[readers]` section. Every reader needs a unique subsection name:
```toml 2. Add your desired readers to the `[readers]` section. Every reader needs a unique subsection name:
[readers]
```toml
[readers]
[readers.REPLACEME] [readers.REPLACEME]
id = "111" id = "111"
machine = "urn:fabaccess:resource:Testmachine" machine = "urn:fabaccess:resource:Testmachine"
[readers.REPLACEMETOO] [readers.REPLACEMETOO]
id = "222" id = "222"
machine = "urn:fabaccess:resource:Another" machine = "urn:fabaccess:resource:Another"
``` ```
# Running
1. Run the adapter:
2. ```shell
python3 main.py
```
## Running
1. Install the requirements with `pip install -r requirements.txt`
2. Run the adapter with at least python 3.7
```shell
python3 main.py
```
3. The adapter has to remain running for the readers to work 3. The adapter has to remain running for the readers to work
# Provisioning # Provisioning
See the [provisioning tool](https://gitlab.com/fabinfra/fabaccess/FabFire-Provisioning-Tool) repo. See the [provisioning tool](https://gitlab.com/fabinfra/fabaccess/FabFire-Provisioning-Tool) repo.