@@ -51,12 +51,17 @@ For a full technical description, please refer to the [documentation] which cont
## Getting Started: Run TSMatch
A full explanation on how to run TSMatch can be found in [documentation], on the TSMatch technical report. This README provides a summarized version of the steps to take.
Each of the components listed above (except the Android app, and the libraries) runs inside a docker container. We provide various
shell scripts to run the TSMatch either locally on a single machine or running each container separately.
### Locally
### Start the TSMatch Engine (server-side) Locally
In order to run TSMatch locally, type the following command:
Ensure that the IP addresses in the various .env files correspond to the IP of your (wireless, local) interface.
In order to run TSMatch on a LAN, type the following command:
```
chmod +x start_tsmatch_locally.sh
...
...
@@ -93,6 +98,43 @@ to access the scripts.
# Contributing
- feel free to contribute to the current release. Please consider the guidelines in CONTRIBUTING.md.
## Synthetic Things
To play with TSMatch, you can use the synthetic Things that are stored in (./thing). Specifically, use the Raspberry PI based Thing, which generates values for Temperature (currently until 20C; you can adapt this). Thing has to be started separately via the start script in the thing/raspberr_pi directory.
## TSMatch client
There is currently an Android app that can be tested. The apk file is located under [TSMatchMobileApp/android/app/build/outputs/apk/release]
Requirements:
- Minimum SDK version of the app is 16. This means it supports Android 4.1 and above.
- In case there is no file manager in the smart phone, install one from the google Play Store. Some popular ones: EZ File Explorer, File Manager.
- Installing unknown apps must be allowed on the smart phone, since the app is not in Play Store.
The way to allow unknown apps on a smart phone changes according to android version. How to do it is explained [here](https://www.verizon.com/support/knowledge-base-222186/).
Installation:
- Connect your phone to a computer with a USB cable and move the APK file into your smart phone, or download it diretly from the git.
- With a file manager, move into the folder where the apk file is located.
- Click on apk file and follow the instructions of the apk installer on your smartphone.
## EFPF Connector
Run with NPM:
```bash
cd efpf_connector
npm install
npm run build
npm run service
```
Run with provided docker container runner script:
```bash
cd efpf_connector
chmod +x start_efpf_connector.sh
./start_efpf_connector.sh
```
# License
Code and documentation copyright 2022 fortiss GmbH, under the MIT license.
