McLinkAgent Configuration

The McLinkAgent is used for several different purposes. The main purpose is as a communication "gateway" between Wired RS485 devices and the MyChild6 Web Server. The McLink Agent can also act as an OTA(Over The Air) server for McPlug devices as well as managing some of the servers local services (Time, MessageBus etc), in this guide we will focus on the default deployment, which covers handling communications for Wired devices as well as OTA duties.

All configuration variables listed in the appsettings.json can also be defined in your environment variables

AllowedHosts

This value tells the software what computers are allowed to connect. This should ways be a * (allow all)

Default Value: *

Urls

Urls controls what Url's the software listens on, typically this should be left at the default value, by default McPlugs will automatically search for OTA on port 5151, while port 9880 is used for the UI and API.

Default Value: http://*:9880;http://*:5151

API Base URL

This should be the url of the MyChild6 API assuming you have deployed the MyChild6 Web server on the same server, API url might look something like `http://localhost/api/` when entering your ApiBaseUrl value

Make sure that your ApiBaseUrl ALWAYS ends with api/  (IE: http://localhost/api/) the slashes are very important to ensure that the api is called correctly

Credentials

• Username
  • This is the username used for the MyChild administrator account
  • Default Value: admin@mychildcloud.com
• Password
  • • This is the password for the administrator account 
    • Default Password <redacted>

We recommend creating a dedicated user for the McLinkAgent to use for communications, instead of using the administrative account. To do this, you would simply create a normal user account with IT Admin permissions to view all of the backend-objects (IE: departments, floors, networks etc.)

API Credentials

• Username
  • This is the username used for the MyChild administrator account
  • Default Value: admin@mychildcloud.com
• Password
  • • This is the password for the administrator account 
    • Default Password <redacted>

The Api Credentials section are separate from the Credentials section above. The Api Credentials are actually used for communications with the Firmware Master API Server. These credentials should be provided by the Development team before deployment beings

EventBus

Entries that are Bold are Required.

For on premise installations this information is local (ie: localhost). If this is a cloud installation the information is provided by Brad Davis. 

• EventBusConnection
• Port
• EventBusUseSSL
• EventBusVirtualHost
• EventBusUserName
• EventBusPassword
• SubscriptionClientName
  • When configuring the McLink Agent service you *MUST* set this value to the "McLinkAgentId" value for the facility the agent will be providing data for.
    • To Find the McLinkAgentId: Login to the MyChild6 Software and browse to the System Admin section, Once in the System Administration section, browse to the Facility list. The AgentId is listed for each facility available and should be *UNIQUE* per facility!
    • Default Value: DefaultFacility (case-sensentive)