Configuration - CDE-GMA/UIC.net-mono.c-sharp GitHub Wiki

Main Configuration

For the beginngin there is only one main setting. The Please configure the project key in the uic_config.json file.

Backup files

all used configurations will be stored in an own json file. The file has the same name as the original configuration file with a trailing "_bak" token. This is helpful if default configuration from inside the code is used.

Details

Basically there are 4 settings files in json format to configure the run time behavior of the UIC.NET solution:

  1. uic_config.json - the basic configuration for the UIC.Framework.Interfaces.UniversalIotConnector which is the local brain and orchestrates the available EDMs and the communication with a connected application or system. The actual configuration is taken from a project which defines the data-points to monitor. Following setting are available:
    • IsEdmSnychronizationEnabled: [true|false] - if set the UicConnector invokes the project agent in order to synchronize the EDM capabilities with a foreign configuration system
    • IsRemoteProjectLoadingEnabled: [true|false] - if set the UicConnector invokes the project agent in order to load the project configuration from a foreign configuration system
    • ProjectKey: - this key defines the project to load from a foreign configuration system
    • ProjectJsonFilePath: - if Remote Project loading is disabled the UicConnector tries to load the project configuration from thus json file
    • CommunicationAgent: [AWS|AZURE|M2MGO] - this options selects the communication agent that should be used. Supported communicaqtion agents are AWS
  2. project.json - this file contains the actual configuration of the embedded system and the necessary EDM data-points and attributes to read and forward to the communication agent
  3. project_agent.json - this file configures the used project agent. The format and content depends on the implementation details of the used project agent. The project agent is responsible to load the current configuration for the UicConnector locally and/or remotely. A second task is to synchronize the capabilities of the local available EDMs with some kind of foreign configuration system.
    • one implementation of the cloud agent is the UIC.Communication.M2mgo.ProjectAgent.M2mgoProjectAgent that communicates with the pst solution from M2MGO
  4. [NAME]_communication_agent.json - this file configures the used communication agent. The format and content depends on the implementation details of the used communication agent. The communication agent is responsible for sending read data-point-values to and receive commands from a foreign application system. There are 3 communication agents for the M2MGO, AZURE and AWS Service.
    • UIC.Communication.M2mgo.CommunicationAgent.M2mgoCommunicationAgentImpl that communicates with the pst solution from M2MGO
      • the configuration is defined in the m2mgo_communication_agent.json
    • UIC.Communication.Azure.CommunicationAgent.AzureCommunicationAgentImpl that communicates with the azure iot hub
      • the configurion for this communication agent is defined in azure_communication_agent.json
    • HAW.AWS.CommunicationAgent.HAWCommunicationAgent is responsible for the communication with the AWS