Difference between revisions of "Getting Started"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| 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" | |||
|+Remote Data Connectivity Configuration Values | |||
!Field | |||
!Required | |||
!Description | |||
!Default | |||
|- | |||
|jfrogToken | |||
|no | |||
|Connection token used to activate remote system administration using JFrog | |||
| | |||
|- | |||
|remoteInfluxServer | |||
|no | |||
|The server URL for a remote Influx 2 database connection | |||
| | |||
|- | |||
|remoteInfluxBucket | |||
|no | |||
|The remote Influx 2 database bucket | |||
| | |||
|- | |||
|remoteInfluxToken | |||
|no | |||
|The connection token for a remote Influx 2 database connection | |||
| | |||
|- | |||
|remoteMqttServer | |||
|no | |||
|The server URL for a remote MQTT uplink connection | |||
| | |||
|- | |||
|remoteMqttType | |||
|no | |||
|The connection type (insecure/TLS) for a remote MQTT uplink connection | |||
| | |||
|- | |||
|remoteMqttUser | |||
|no | |||
|The username for a remote MQTT uplink connection | |||
| | |||
|- | |||
|remoteMqttPassword | |||
|no | |||
|The password for a remote MQTT uplink connection | |||
| | |||
|} | |||
== Application Setup == | |||
See [[Hello World]] example. | |||
== Monitoring == | == Monitoring == | ||
Latest revision as of 01:42, 26 November 2022
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 http://heatwebbems/ 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.
| 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) |
| 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.
| Field | Required | Description | Default |
|---|---|---|---|
| jfrogToken | no | Connection token used to activate remote system administration using JFrog | |
| remoteInfluxServer | no | The server URL for a remote Influx 2 database connection | |
| remoteInfluxBucket | no | The remote Influx 2 database bucket | |
| remoteInfluxToken | no | The connection token for a remote Influx 2 database connection | |
| remoteMqttServer | no | The server URL for a remote MQTT uplink connection | |
| remoteMqttType | no | The connection type (insecure/TLS) for a remote MQTT uplink connection | |
| remoteMqttUser | no | The username for a remote MQTT uplink connection | |
| remoteMqttPassword | no | The password for a remote MQTT uplink connection |
Application Setup
See Hello World example.
Monitoring
- Setup Free Influx 2 Database Account... https://www.influxdata.com/influxcloud-trial
- Setup Free Grafana Account... https://grafana.com/ (or install Grafana locally on a computer using Docker)
- Create an Influx Bucket
- Create an API Token for Read/Write access on the new bucket (keep this safe)
- Connect Controller to Influx bucket
- Connect Grafana to Influx bucket
- Import dashboard to Grafana