This app connects Interact Lighting API and gathers information about data of Signify spaces.
The app needs environment variables and database tables for configuration. To edit the database tables the app provides an own API access.
To start and initialize an app in an Eliona environment, the app has to be registered in Eliona. For this, entries in database tables public.eliona_app and public.eliona_store are necessary.
This initialization can be handled by the reset.sql script.
-
CONNECTION_STRING: configures the Eliona database. Otherwise, the app can't be initialized and started (e.g.postgres://user:pass@localhost:5432/iot). -
INIT_CONNECTION_STRING: configures the Eliona database for app initialization like creating schema and tables (e.g.postgres://user:pass@localhost:5432/iot). Default is content ofCONNECTION_STRING. -
API_ENDPOINT: configures the endpoint to access the Eliona API v2. Otherwise, the app can't be initialized and started. (e.g.http://api-v2:3000/v2) -
API_TOKEN: defines the secret to authenticate the app and access the Eliona API. -
API_SERVER_PORT(optional): define the port the API server listens. The default value is Port3000. -
LOG_LEVEL(optional): defines the minimum level that should be logged. The default level isinfo.
The app requires configuration data that remains in the database. To do this, the app creates its own database schema signify during initialization. To modify and handle the configuration data the app provides an API access. Have a look at the API specification how the configuration tables should be used.
-
signify.configuration: Contains configuration of the app. Editable through the API. -
signify.asset: Provides asset mapping. Maps broker's asset IDs to Eliona asset IDs.
Generation: to generate access method to database see Generation section below.
The app provides its own API to access configuration data and other functions. The full description of the API is defined in the openapi.yaml OpenAPI definition file.
- API Reference shows details of the API
Generation: to generate api server stub see Generation section below.
This app creates Eliona asset types and attribute sets during initialization.
The data is written for each device, structured into different subtypes of Eliona assets. The following subtypes are defined:
Input: Current values reported by spaces
Assets for all spaces connected to the configured API are created automatically when the configuration is added. The assets are create hierarchically in ELiona beginning with site > building > storey > spaces.
To select which assets to create, a filter could be specified in config. The schema of the filter is defined in the openapi.yaml file. Example filter that takes only spaces with name pattern Pow* or object type is one of site, building or storey.
[
[{"parameter": "name", "regex": ".*Pow.*"}],
[{"parameter": "object_type", "regex": "(site|building|storey)"}]
]
Possible filter parameters are defined in the structs in signify/data.go and marked with eliona:"attribute_name,filterable" field tag.
To avoid conflicts, the Global Asset Identifier is a manufacturer's ID prefixed with asset type name as a namespace.
An example dashboard meant for a quick start or showcasing the apps abilities can be obtained by accessing the dashboard endpoint defined in the openapi.yaml file. The existing dashboard template names are defined in metadata.json and in openapi.yaml.
For the API server the OpenAPI Generator for go-server is used to generate a server stub. The easiest way to generate the server files is to use one of the predefined generation script which use the OpenAPI Generator Docker image.
.\generate-api-server.cmd # Windows
./generate-api-server.sh # Linux
For the database access SQLBoiler is used. The easiest way to generate the database files is to use one of the predefined generation script which use the SQLBoiler implementation. Please note that the database connection in the sqlboiler.toml file have to be configured.
.\generate-db.cmd # Windows
./generate-db.sh # Linux