Skip to content

Latest commit

 

History

History
112 lines (61 loc) · 5.71 KB

README.md

File metadata and controls

112 lines (61 loc) · 5.71 KB
Raw
Replace the following strings globally with the real app name:
  • app-name with app's name. Use - if the app name contains spaces. All letters are lower-cased.
  • app_schema_name and app\\_schema\\_name with app's name. Use _ if the app name contains spaces. All letters are lower-cased.
  • App Name with app's real names. Letters can be mixed-cased, depends on using e.g. brand names.

Eliona App for App Name

The App Name app is used to access App Name.

Configuration

The app needs environment variables and database tables for configuration. To edit the database tables the app provides an own API access.

Registration in Eliona

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.

Environment variables

Todo: Describe further environment variables tables the app needs for configuration

  • 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 of CONNECTION_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 Port 3000. Todo: Decide if the app needs its own API. If so, an API server have to implemented and the port have to be configurable.

  • LOG_LEVEL(optional): defines the minimum level that should be logged. The default level is info.

Database tables

Todo: Describe other tables if the app needs them.

The app requires configuration data that remains in the database. To do this, the app creates its own database schema app_schema_name 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.

  • app_schema_name.configuration: Contains configuration of the app. Editable through the API.

  • app_schema_name.asset: Provides asset mapping. Maps broker's asset IDs to Eliona asset IDs.

Generation: to generate access method to database see Generation section below.

References

App API

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.

Generation: to generate api server stub see Generation section below.

Eliona assets

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:

  • Info: Static data which provides information about a device like address and firmware info.
  • Status: Device status information, like battery level.
  • Input: Current values reported by sensors.
  • Output: Values that are to be passed back to the provider.

Continuous asset creation

Assets for all devices connected to the App Name account are created automatically when the configuration is added.

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.

Possible filter parameters are defined in the structs in broker.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.

Dashboard

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.

Tools

Generate API server stub

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

Generate Database access

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.

.\generate-db.cmd # Windows
./generate-db.sh # Linux

Generate asset type descriptions

For generating asset type descriptions from field-tag-annotated structs, asset-from-struct tool can be used.