Difference between revisions of "Getting Started"

From Open Source Controls Wiki
Jump to navigation Jump to search
Line 1: Line 1:
== Controller Setup ==
# Unpack controller
# Plug controller in to network using Ethernet cable
# Connect 12v power supply and turn on
# Navigate to controller UI on local network via <nowiki>http://heatwebbems/</nowiki> or the IP address shown on the controller display (if present).
# Follow on screen instructions
# Enter WiFi details (if required)
== Configuration ==
The following standard details can be entered via the setup user interface.
{| class="wikitable"
|+Standard Configuration Values
!Field
!Required
!Description
!Default
|-
|network
|yes
|Unique identifier for the controls network the controller sits in.
|Factory assigned random id (same as NodeId)
|-
|node
|fixed
|Unique identifier for the controller.
|Factory assigned random id
|-
|title
|yes
|A controller's title or name.
|"Zero Carbon Controller " + ''node''
|-
|adminPassword
|yes
|For system access.
|Random factory assigned password (see controller label)
|-
|email
|no
|Default email address.
|
|-
|postCode
|no
|The post code where the controller is installed
|
|}
The additional details can be entered to enable remote monitoring and control.
{| class="wikitable"
|+Data Connectivity Configuration Values
!Field
!Required
!Description
!Default
|-
|influxServer
|no
|The server URL for a remote Influx 2 Database connection
|
|-
|influxToken
|no
|The connection token for a remote Influx 2 Database connection
|
|-
|mqttServer
|no
|The server URL for a remote MQTT uplink connection
|
|-
|mqttType
|no
|The connection type (insecure/TLS) for a remote MQTT uplink connection
|
|-
|mqttUser
|no
|The username for a remote MQTT uplink connection
|
|-
|mqttPassword
|no
|The password for a remote MQTT uplink connection
|
|}
== Application Setup ==
See [[Hello World]] example.
== Monitoring ==
== Monitoring ==



Revision as of 16:56, 25 November 2022

Controller Setup

  1. Unpack controller
  2. Plug controller in to network using Ethernet cable
  3. Connect 12v power supply and turn on
  4. Navigate to controller UI on local network via http://heatwebbems/ or the IP address shown on the controller display (if present).
  5. Follow on screen instructions
  6. Enter WiFi details (if required)

Configuration

The following standard details can be entered via the setup user interface.

Standard Configuration Values
Field Required Description Default
network yes Unique identifier for the controls network the controller sits in. Factory assigned random id (same as NodeId)
node fixed Unique identifier for the controller. Factory assigned random id
title yes A controller's title or name. "Zero Carbon Controller " + node
adminPassword yes For system access. Random factory assigned password (see controller label)
email no Default email address.
postCode no The post code where the controller is installed


The additional details can be entered to enable remote monitoring and control.

Data Connectivity Configuration Values
Field Required Description Default
influxServer no The server URL for a remote Influx 2 Database connection
influxToken no The connection token for a remote Influx 2 Database connection
mqttServer no The server URL for a remote MQTT uplink connection
mqttType no The connection type (insecure/TLS) for a remote MQTT uplink connection
mqttUser no The username for a remote MQTT uplink connection
mqttPassword no The password for a remote MQTT uplink connection

Application Setup

See Hello World example.

Monitoring

  1. Setup Free Influx 2 Database Account... https://www.influxdata.com/influxcloud-trial
  2. Setup Free Grafana Account... https://grafana.com/ (or install Grafana locally on a computer using Docker)
  3. Create an Influx Bucket
  4. Create an API Token for Read/Write access on the new bucket (keep this safe)
  5. Connect Controller to Influx bucket
  6. Connect Grafana to Influx bucket
  7. Import dashboard to Grafana