Device definitions

Device definitions configure how an Edge Controller works. The definition also configures the Giraffe website and mobile app (such as what buttons are shown and how they are labelled).

As an example, we can use device definitions to map output 4 to strobe lights, and output 5 to strobe light pattern select for one customer.

If another customer wants to connect the strobe lights to output 2 and 3, we can remap this using another device definition.

Definition per class, not per asset

It is important to minimise the number of device definitions you have. If you create too many definitions, it becomes extremely cumbersome to maintain them all.

Ideally you will have one device definition per 'class' of asset, and then you will use optional features to configure those assets. For instance, you may create a definition for solar tower version 1 but then use optional features to toggle whether it has floodlights fitted or not.

Optional features let you tweak aspects of the definition on a per system basis without having to create lots of different definitions.

The reason for needing to configure assets like this, is that, if you build an asset with floodlights, we will need to show a button in the UI to control those floodlights - as well as raising an error state if they are not working properly. If you then subsequently build an asset without floodlights, the Platform must not show an error saying that the floodlights are not working.

System vs IFU definition

A definition can be applied to both a system or an IFU. Generally, we apply a very generic definition at the IFU level and then a customer specific definition at the system level.

The benefit of this is that the Edge Controller can be swapped without needing to update the system definition.

In certain cases, it is necessary or advantageous for us to create a custom IFU definition for a customer as well.

What is configurable?

The following capabilities are configurable on an Edge Controller:

Capabilities	Provided functionality
Router integration (deprecated)	This is a legacy integration for routers prior to our new router integration. It is no longer used
Relay Board	This enables the optional external relay board that is typically fitted at the top of the mast
GPS	This enables GPS features. If it is disabled, a message is shown in the platform that the feature is disabled. This option configures the source of the GPS location
Speaker	This enables the amplifier and speaker integration and tells the Edge Controller which output it needs to enable prior to starting a talkdown
Victron MPPT	This enables integration with a Victron MPPT solar charger
Victron BMV	This enables integration with a Victron Smart Shunt current sensor
Mains Power	This is for monitoring mains power connectivity (shore power)
Door Sensor	This is for monitoring door sensors
Run Switch	This is for having an external on / off switch that gives advance notice of the system being switched off
PIRs (1-4)	This is for connecting hardwired PIR sensors
Power Outputs (1-4)	These are typically used for controlling power to cameras, but can also be used for other types of accessory. They have various options such as inversion, default state, forcing them on at boot and defining where they are (either on the Edge Controller or on the relay board)
Siren	This is used for controlling a physical siren (as opposed to a siren emulated through the speakers)
Strobe Lights	This is used for defining a set of strobe lights. You can also define a pattern select output used for toggling through the different sets of flash patterns available on many strobe lights
Floodlights	This is used for configuring flood lights. Floodlights can be linked to schedules
IR Illuminators	This is used for configuring IR illuminators. They can be linked to schedules
Fan	This is used for defining the fan configuration
Battery	This is used for defining the type of battery and it's default capacity. The capacity can be overwritten on a per asset basis
System Power	This defines options relating to the systems power sensor including at what voltage it will enter low power mode
Aux Power	This is similar to mains power but for a secondary power source
Tamper Sensor	This is for an external tamper sensor
Tilt Sensor	This is for an external tilt sensor
Ethernet Switch	This is used to define the IP address of a managed ethernet switch
EFOY	This defines whether there should be an EFOY fuel cell connected to the Edge Controller via serial