North HeatmiserNeo User manual

The HeatmiserNeo Driver
The HeatmiserNeo driver connects to the Heatmiser Neo heating and hot water control system.
Available for Commander and ObSys.
This document relates to HeatmiserNeo driver version 2.0
Please read the Commander Manual or ObSys Manual alongside this document, available from
www.northbt.com
°C

The HeatmiserNeo Driver 2
Contents
Compatibility with the Heatmiser Neo System ........................................................................... 3
Equipment ........................................................................................................................................3
Values ................................................................................................................................................3
Prerequisites .....................................................................................................................................4
Using the Driver ............................................................................................................................ 5
Starting the Interface........................................................................................................................5
Setting up the Driver.........................................................................................................................5
Checking Communications ..............................................................................................................5
Object Specifications.................................................................................................................... 6
Example Object Reference ...............................................................................................................6
Device Top-Level Objects .................................................................................................................6
Heatmiser Driver Setup ....................................................................................................................7
Find neoHub .....................................................................................................................................8
Heatmiser Advanced Setup ..............................................................................................................9
Heatmiser System...........................................................................................................................10
System.............................................................................................................................................11
Thermostat .....................................................................................................................................12
Time Clock ......................................................................................................................................15
neoPlug ...........................................................................................................................................17
All Zones..........................................................................................................................................18
All Thermostats...............................................................................................................................19
All Time Clocks................................................................................................................................20
Driver Versions ............................................................................................................................ 21

The HeatmiserNeo Driver 3
Fig. 1 North to Heatmiser Neo
Compatibility with the Heatmiser Neo System
The HeatmiserNeo driver allows North to interface with the Heatmiser Neo underfloor heating and hot
water control system.
The driver connects, via an Ethernet network, to a single Heatmiser neoHub (Fig. 1). The neoHub
supports up to 32 zone devices, including thermostats, time clocks and accessories.
The neoHub zones are polled by the driver for their values. These values are stored and made available as
objects.
Equipment
Heatmiser devices compatible with the driver include:
•neoHub gateway (1st or 2nd generation)
•neoStat thermostats and timeclocks
•neoAir battery-powered thermostats
•neoPlug power sockets
Values
Depending on the type of thermostat or timeclock devices connected, each zone typically has the
following values available:
•Room temperature
•Floor temperature
•Standby mode
•Temperature setpoints
•Comfort level profiles
•Time clock times
•PIN lock
•Hold
•Away
•Output delay
•Program mode
•Temperature format
•Date & time
The HeatmiserNeo system does not generate alarm event messages.
Zigbee
Heatmiser
neoHub
Heatmiser Neo
Devices
IP Network
North device
°C

The HeatmiserNeo Driver 4
Prerequisites
A neoHub with firmware version 2081 or later is required.
Use the Heatmiser Neo app on a mobile device to set up the neoHub and zones.
The neoHub is assigned an IP address from the local network’s DHCP server; a static IP address cannot be
assigned. If possible, we recommend creating a reservation for the neoHub within the router/DHCP
server. If you are unable to find the IP address of the neoHub from the DHCP server, use the Find neoHub
feature in the driver to scan the IP network.
Be cautious of adjusting values too frequently. The Heatmiser system uses a Zigbee wireless network
with limited bandwidth, sending too many adjustments may cause requests to build up in the neoHub
and the system to slow. Use the Write Messages Sent (A.WC) object to monitor how frequently
adjustments are made.
The neoHub may become slow to respond – typically if there are problems with its wireless network, or
values are adjusted too frequently. Use the neoHub Responding Slowly (A.NS) and Message Reply Time
(A.RT) objects to monitor for this issue. If the driver fails to get a response from the neoHub in a timely
manner, then it will disconnect and stop making requests for two minutes, allowing the Heatmiser
system time to recover.
If you are connecting to a neoHub via a firewall, then the driver will require access to TCP port 4242 on
the Heatmiser neoHub.

The HeatmiserNeo Driver 5
Using the Driver
On ObSys, the HeatmiserNeo driver is pre-installed. On Commander, the driver is available to download
in the file ‘Bank11 HeatmiserNeo.cdm’. On all of these North devices, you can use the driver to create an
interface to Heatmiser. Once started, you will need to set up the driver before it can communicate with
the Heatmiser Neo system.
Starting the Interface
To start an interface using the HeatmiserNeo driver, follow these steps:
Start Engineering your North device using ObSys
Navigate to Configuration, Interfaces, and set a unused Interface to ‘HeatmiserNeo’ to start the
particular interface
Navigate to the top-level of your North device, then rescan it
The driver setup object (Mc), labelled Heatmiser Setup, should now be available. If this object is not
available, check an interface licence is available and the driver is installed.
Setting up the Driver
To set up the driver, follow these steps:
Navigate to the Heatmiser Setup object (Mc). For example, if you started interface 1 with the driver
earlier, then the object reference will be ‘M1’
Set the Host name/IP address object (IA) to the IP address or host name of the neoHub.
Checking Communications
You can check that the interface is communicating by reading the Device Communicating object (DS). A
value of ‘yes’ indicates the driver has connected to, and is communicating with, the neoHub.

The HeatmiserNeo Driver 6
Object Specifications
Once an interface is started, one or more extra objects become available within the top-level object of
the device. As with all North objects, each of these extra objects may contain sub-objects, (and each of
these may contain sub-objects, and so on) - the whole object structure being a multi-layer hierarchy. It is
possible to navigate around the objects using the ObSys Engineering Software.
Each object is specified below, along with its sub-objects.
Example Object Reference
An example of a reference to an object in the same device: the Heatmiser System (S1) contains
Heatmiser zone one (Z1). This zone contains a Standby state(V46). Therefore, the complete object
reference is ‘S1.Z1.V46’.
An example of a reference to an object in a different device: the IP network object (IP) contains Default
Commander object (CDIP), which contains the object above (S1.Z1.V46) – therefore the complete object
reference is ‘IP.CDIP.S1.Z1.V46’.
Device Top-Level Objects
When an interface is started using the HeatmiserNeo driver, the objects below become available within
the top-level object of the device. For example, if interface 1 is started, then the object references ‘M1’
and ‘S1’ become available.
Description
Reference
Type
Heatmiser Setup
Set up the HeatmiserNeo driver, started on
interface c(cis the interface number)
Mc
Fixed Container:
On the Commander platform this will be
[CDM v20\HeatmiserNeo v20]
On the ObSys platform this will be
[OSM v20\HeatmiserNeo v20]
Heatmiser System
Access Heatmiser system connected to
interface c(cis the interface number)
Sc
Fixed Container:
[HeatmiserNeo v20]

The HeatmiserNeo Driver 7
Heatmiser Driver Setup
Object Type: [OSM v20\HeatmiserNeo v20]
Object Type: [CDM v20\HeatmiserNeo v20]
The HeatmiserNeo driver contains the following objects:
Description
Reference
Type
Device Label
Label displayed when scanning the system
DL
Obj\Text: max. 20 chars; Adjustable
Host name/IP address
The host name or IP address of the
neoHub. If specifying a host name include
the full domain name, eg ‘Neo-
hub.yourdomain.com’
IA
Obj\Text: max. 63 chars; Adjustable
Find neoHub
If you are unable to find the IP address of
your neoHub, use this object to scan IP
addresses on the local network
F
Fixed container:
On the Commander platform this will be
[CDM v20\HeatmiserNeo v20\Find]
On the ObSys platform this will be
[OSM v20\HeatmiserNeo v20\Find]
Device Communicating
Indicates the driver has connected to and
is communicating with the neoHub
DS
Obj\NoYes
Default Hold Time (mins)
Default time to use when setting Hold
Temperature or Timer Boost Time
HT Obj\Num; Adjustable
Last Write Response
Response message from neoHub after last
set command
LR
Obj\Text
Advanced Setup
Additional configuration options for the
driver operation
A
Fixed container:
On the Commander platform this will be
[CDM v20\HeatmiserNeo v20\Advanced]
On the ObSys platform this will be
[OSM v20\HeatmiserNeo v20\Advanced]

The HeatmiserNeo Driver 8
Find neoHub
Object Type: [OSM v20\HeatmiserNeo v20\Find]
Object Type: [CDM v20\HeatmiserNeo v20\Find]
The Find neoHub object triggers the driver to start searching the local network for a neoHub.
A DHCP servers assigns an IP address to the neoHub, and if a local DNS server is available, the neoHub
can be accessed using the host name ‘Neo-hub.yourdomain.com’. If a local DNS server is not available,
and the DHCP server’s IP address leases are not visible, then the Find Now object (N) can find the neoHub
on the network.
Once you have set Find Now object (N) to ‘yes’, the driver will listen for a connect button press on the
neoHub. In addition, the driver attempts each IP address on the local subnet in turn, which can take a
while.
Optional start and end IP addresses may be specified to limit the range of the search. If they are not
specified, then IP address range of the North device is used.
Enable the Auto Find object (A) to re-find the neoHub if its IP address changes.
The State object (S) provides a description of which IP address the driver is currently attempting.
Description
Reference
Type
Find Now
Set the driver to start searching for a
neoHub on the local IP network, then
press ‘connect’ on the neoHub
N
Obj\NoYes; Adjustable
Auto Find
Automatically attempt to find the neoHub
again if communications are lost
A
Obj\NoYes; Adjustable
Start IP address
Optional. First IP address to check for the
neoHub.
If not specified, then the first IP on the
local subnet will be used, eg ‘192.168.1.1’.
IS
Obj\IP; Adjustable
End IP Address
Optional. Last IP address to check for the
neoHub.
If not specified, then the last IP on the
local subnet will be used, eg
‘192.168.1.254’.
IE
Obj\IP; Adjustable
State
Description of current find action
S Obj\Text

The HeatmiserNeo Driver 9
Heatmiser Advanced Setup
Object Type: [OSM v20\HeatmiserNeo v20\Advanced]
Object Type: [CDM v20\HeatmiserNeo v20\Advanced]
The HeatmiserNeo driver advanced setup contains the following objects.
Description
Reference
Type
Reset Driver
This will clear the driver’s database of
values and then re-initialize
communications with the neoHub
RST
Obj\NoYes; Adjustable
Value Read Update Time (s)
The driver polls the neoHub periodically,
storing all values in its database. The
driver waits for this time period before
polling for values again
UT
Obj\Num: 15…1200; Adjustable
Default: 65s
Responding Slowly
Indicates that the neoHub is taking longer
than usual to respond (more than 20
seconds). This could indicate a
configuration problem with the neoHub
wireless network.
NS
Obj\NoYes
Response Time (s)
The driver makes several different
requests to read all values from the
neoHub. This value reports the longest
time taken for a reply
RT Obj\Num
Value Writes Sent (per min)
Indicates how many value adjustments the
driver has sent to the neoHub in the last
minute. Adjusting values too frequently
can cause problems with the Heatmiser
system.
WC
Obj\Num
Debug Enable
This will store additional debug
information in the record file. Use this
option only when instructed by North
Support
DE
Obj\NoYes; Adjustable

The HeatmiserNeo Driver 10
Heatmiser System
Object Type: [HeatmiserNeo v20]
The Heatmiser Neo system contains up to 32 zone devices, connected wirelessly to a neoHub. Objects are
available to read and set values within each zone (Zx) and the system (S). Objects are also available to set
values in all zones (AZ), all thermostats (AS), and all time clocks (AT).
Description
Reference
Type
System
System-wide settings held by the neoHub
S
Fixed container:
[HeatmiserNeo v20\System]
Zone Label
The Heatmiser zone number, x, is in the
range 1…99. However, a maximum of 32
zones are supported.
Zx
Fixed container depending on device type.
neoStat devices configured as thermostat:
[HeatmiserNeo v20\Thermostat]
neoStat devices configured as timeclock:
[HeatmiserNeo v20\Timeclock]
neoPlug devices:
[HeatmiserNeo v20\Switch]
Unknown device:
[HeatmiserNeo v20\Unknown]
All Zones
Set values in all devices
AZ
Fixed container:
[HeatmiserNeo v20\AllZone]
All Thermostats
Set values in all neoStat thermostat
devices
AS
Fixed container:
[HeatmiserNeo v20\AllThermostat]
All Timeclocks
Set values in all neoStat timeclock devices
AT
Fixed container:
[HeatmiserNeo v20\AllTimeclock]