ICT EF-NODE User manual

(EF-NODE)
Electric Fence Node Manual

Contents
1. Introducon����������������������������������������������������������������������������������������������������������� 4
2. Device Operaon ���������������������������������������������������������������������������������������������� 5
2.1 Aaching The Antenna���������������������������������������������������������������������������������������������������� 5
2.2 Device Power & Power Buon���������������������������������������������������������������������������������������� 5
2.3 Pre-Installaon Device Conguraon����������������������������������������������������������������������������� 5
2.4 Installaon ����������������������������������������������������������������������������������������������������������������������� 5
2.5 Site-Specic Calibraon �������������������������������������������������������������������������������������������������� 6
2.6 Site-Calibrated Example Data ����������������������������������������������������������������������������������������� 6
3. Device Conguraon�������������������������������������������������������������������������������������� 7
3.1 Conguraon Commands ����������������������������������������������������������������������������������������������� 8
3.1.1 Firmware Version – version����������������������������������������������������������������������������������� 8
3.1.2 Save Current Device Conguraon – save������������������������������������������������������������ 8
3.1.3 Reload Saved Conguraon – load����������������������������������������������������������������������� 8
3.1.4 Reset to Factory Defaults – cong reset ��������������������������������������������������������������� 9
3.2 General LoRaWAN™ Conguraon��������������������������������������������������������������������������������� 9
3.2.1 LoRaWAN EUIs – lora eui �������������������������������������������������������������������������������������� 9
3.2.2 LoRaWAN Applicaon/Join Key – lora key app ��������������������������������������������������� 10
3.2.3 LoRaWAN Network Joined Status – lora joined�������������������������������������������������� 10
3.2.4 LoRaWAN Public Network Mode – lora net public ��������������������������������������������� 11
3.2.5 LoRaWAN Adapve Data Rate – lora net adr����������������������������������������������������� 11
3.2.6 ADR Link Check Period– linkcheck period ����������������������������������������������������������� 12
3.2.7 LoRaWAN Default Data Rate – lora data rate ���������������������������������������������������� 12
3.2.8 LoRaWAN Maximum TX Power – lora tx power ������������������������������������������������� 13
3.2.9 Conrmed Messaging – lora conrmed ������������������������������������������������������������� 13
3.2.10 LoRa Band ��������������������������������������������������������������������������������������������������������� 14
3.3 LoRaWAN Acvaon-by-Personalisaon Mode����������������������������������������������������������� 15
3.3.1 LoRaWAN Acvaon-by-Personalisaon – lora net abp ������������������������������������ 15
3.3.2 LoRaWAN Session Keys – lora key session ���������������������������������������������������������� 15
3.3.3 LoRaWAN Device Address – lora net dev addr ��������������������������������������������������� 16
3.3.4 LoRaWAN Network Indener – lora net id ������������������������������������������������������� 16
3.4 Timing ���������������������������������������������������������������������������������������������������������������������������� 17
3.4.1 Time to Retransmit – backo inial�������������������������������������������������������������������� 17
3.4.2 Maximum Retransmit Time aer Failed Communicaon – backo max����������� 17

3.4.3 Period Between Reports – report period ������������������������������������������������������������ 18
3.5 Unique EF-NODE Commands���������������������������������������������������������������������������������������� 19
3.5.1 Send Fence Strength Command – fence strength ���������������������������������������������� 19
3.5.2 Send Baery Test – baery test �������������������������������������������������������������������������� 19
3.5.3 Fence Low Alarm – fence threshold�������������������������������������������������������������������� 19
4. Decoder Notes �������������������������������������������������������������������������������������������������� 20

The EF-NODE Box - Mounng Hole Opons at Back
The ICT Internaonal EF-NODE is a non-contact
LoRaWAN™ electric fence fault detecon sensor.
The EF-NODE awakens at dened intervals and
listens for the presence of radio-frequency
interference, if it cannot detect a fence or it
determines the fence strength is weak it will
transmit a LoRaWAN alarm.
The unit will also periodically transmit the
minimum, maximum and average strength of RF
interference produced by the fence.
□LoRaWAN™ low-power, long-range
connecvity;
□Fully recongurable via USB or LoRaWAN
downlink;
□In-built RF Interference detecon;
□Ultra-low-power operaonal modes that
allow advanced power saving and smart
sleep-to-wakeup funcons.
The EF-NODE Box - With Antenna
1. Introducon
ICT INTERNATIONAL Operation Manual EF-NODE
4

The EF-NODE Box - Power On/O Buon
Installaon Diagram
2.1 Aaching The Antenna
Before aaching the Antenna, remove the risk of inducing an stac
electric discharge to the Node by carefully grounding the SMA (M)
pin of the Antenna to the outer brass rim of the SMA (F) connector
on the Node.
2.2 Device Power & Power Buon
The EF-NODE runs o 3x 1.5V AA baeries – ICT Internaonal
recommends Energizer Ulmate Lithium or similar high-end
baeries.
To begin transming, press the power buon at the boom of the
device, this buon is a latching switch and we remain on unl the
buon is pressed again.
2.3 Pre-Installaon Device Conguraon
Connect the device to the computer, following the instrucons in
Secon 3 ‘Device Conguraon’.
From the computer, connect the device to the Network Server,
such as TTN (hps://www.thethingsnetwork.org/). Sengs such as
upload intervals, user sengs and general commands can be done
prior to installaon. Commands from secon 3.5 ‘Unique EF-NODE
Commands’ will need to be congured on site to callibrate with in-
situ condions.
2.4 Installaon
The EF-NODE measures RF intensity and provides a current RF
intensity value, a relave metric callibrated to the site, which is
used as an indicaon of fence pulsing strength.
It’s recommended that the EF-NODE should be installed between
0.3m and 1m above the electric fence.
2. Device Operaon
Carefully Grounding The Antenna
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 5

2.6 Site-Calibrated Example Data
The graph (right) demonstrates an electric fence being
monitored. A high at line describes the electric fence
as on and running uninterrupted at full strength.
A steep decline and low at line shows when the
electricity was o. The sporadic line movement shows
that electricity is running but it is being interrupted by a
trip, requiring aenon.
if(decoded.fence_signal > 2000) {
decoded.fence_on = “Fence on”;
} else{
decoded.fence_on = “Fence o”;
}
decoded.status = bytes[byte++];
decoded.rssi = bytes[byte++] *
-1;
decoded.snr = bytes[byte++];
decoded.tx_pwr = bytes[byte++];
return decoded;
Payload Decoder Calibraon - Midway Value Locaon
RF Intensity As a Relave Metric - Site-Calibrated
2.5 Site-Specic Calibraon
Upon installaon, the baseline RF intensity of an
operaonal fence should be measured using the
command as dened in 3.5.1 in this manual. This status
will be a relave metric of RF intensity, unique to the site.
The RF intensity of an unpowered and tripped fence
should then be measured using the same procedure.
These values should be inpued into the payload decoder
to dene operaonal and non-operaonal states.
Input into the payload decoder the midway value
calulated from the recorded operaonal and non-
operaonal states. In this payload decoder example
2000 is the midway value.
2. Device Operaon
Electric Fence On: Full StrengthElectric Fence On: Full Strength
Electric Fence OElectric Fence O
Electric Fence OnElectric Fence On
And TrippedAnd Tripped
ICT INTERNATIONAL Operation Manual EF-NODE
6

To retrieve or reprogram LoRaWAN keys (OTAA), enter the following:
Be sure to save aer changing any sengs. This device has been precongured as the following:
DEV EUI:
Upload Interval:
The upload schedule can be changed using the command report period. For example, to change the upload
interval to 10 minutes: report period 600. Please see ICT Internaonal’s YouTube video on registering an
applicaon to The Things Network at hps://youtu.be/dJ5gdZMBDK0.
To Retrieve: To Reprogram:
lora eui dev lora eui dev 0011223344556677
lora eui app lora eui app 0011223344556677
lora key app lora key app 00112233445566778899887766554433
Conguraon Program Example
The ICT Internaonal EF-NODE is congured (i.e. idened and
authencated) over USB serial console using a terminal/terminal
emulator.
To gain access to conguraon mode the EF-NODE must be switched o
for a minimum of 3 minutes, then connect it to the computer with USB
cable while it remains o. With the USB cable connected, switch on the
power of the EF-NODE, and the Green LED will ash.
At the end of conguring the EF-NODE, remove the USB cable, and the EF-
NODE will reboot and start to join the network.
It is compable with Windows 10, Mac OS and Linux. One terminal emulator we recommend is Puy,
which can be downloaded from hps://www.puy.org/.
All commands are entered as ASCII text and will return any response as ASCII text. Connecng an EF-NODE
to a computer via the Micro USB port will provide a serial port for conguraon.Recommended sengs
are as follows:
□Baud Rate: 115200 baud
□Bits: 8
□Parity: None
□Stop Bits: 1
□Flow Control: Disabled.
3. Device Conguraon
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 7

3.1 Conguraon Commands
These commands are entered into a terminal or terminal emulator such as Puy, hps://www.puy.org/,
to acon several types of commands to the EF-NODE.
3.1.1 Firmware Version – version
Command Input: version
Compable: Device Firmware Versions > 1.2
Command Descripon: Returns informaon about the device rmware version and
congured frequency.
3.1.2 Save Current Device Conguraon – save
Command Input: save
Compable: All Device Firmware Versions
Command Descripon: Saves the running conguraon to permanent storage.
3.1.3 Reload Saved Conguraon – load
Command Input: load
Compable: All Device Firmware Versions
Command Descripon: Saves the running conguraon to permanent storage.
Command
Type Syntax Used Response Type Example Result of Command
Get version <String> Denium Technologies Pty Ltd
LoRaWAN Class-A Sensor 235c0e89-dirty
Luna Station 4000096001-”AS923”
Command
Type Syntax Used Response Type Example Result of Command
Acon save Saved cong Saved cong
Command
Type Syntax Used Response Type Example Result of Command
Acon load Loaded cong Loaded cong
ICT INTERNATIONAL Operation Manual EF-NODE
8

3.1.4 Reset to Factory Defaults – cong reset
Command Input: cong reset
Compable: Device Firmware Versions > 1.2
Command Descripon: Resets the running conguraon factory defaults.
Command
Type Syntax Used Response Type Example Result of Command
Get cong reset Reset app
cong to
defaults
Reset app cong to defaults
3.2 General LoRaWAN™ Conguraon
These commands are entered into a terminal or terminal emulator such as Puy, hps://www.puy.org/,
to acon several types of commands to the EF-NODE.
3.2.1 LoRaWAN EUIs – lora eui
Command Input: lora eui
Compable: All Device Firmware Versions
Command Descripon: Manage the device’s LoRaWAN EUIs (unique idener), both device and applicaon/
join (dependent on LoRaWAN version).
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora eui <type> lora eui app
1122334455667788
<eui> lora eui app
0x11 0x22 0x33 0x44
0x55 0x66 0x77 0x88
Set lora eui <type>
<eui>
lora eui dev
1122334455667788
<eui> lora eui app
0x11 0x22 0x33 0x44
0x55 0x66 0x77 0x88
0x11 0x22 0x33 0x44
0x55 0x66 0x77 0x88
Parameter Type Descripon
<type> String Type of EUI, opons are:
dev: Device EUI
app: Applicaon/Join EUI
<eui> String 16 character Hexadecimal string represenng an 8-byte EUI. Example:
0x11 0x22 0x33 0x44 0x55 0x66 0x77 0x88
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 9

3.2.2 LoRaWAN Applicaon/Join Key – lora key app
Command Input: lora key app
Compable: All Device Firmware Versions
Descripon: Manage the device’s LoRaWAN applicaon/join key used for Over-the-Air Acvaon (OTAA).
3.2.3 LoRaWAN Network Joined Status – lora joined
Command Input: lora joined
Compable: All Device Firmware Versions
Descripon: Manage the device’s LoRaWAN applicaon/join key used for Over-the-Air Acvaon (OTAA).
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora key
app
lora eui app
1122334455667788
<key> lora key app
00112233445566778899AABBCCDDEEFF
Set lora
key app
<key>
lora key app <key> lora eui app
1122334455667788AABBCCDDEEFFGGHH
1122334455667788AABBCCDDEEFFGGHH
Parameter Type Descripon
<key> String 32 character Hexadecimal string represenng an 16-byte EUI. Example:
0x11 0x22 0x33 0x44 0x55 0x66 0x77 0x88 0xAA 0xBB 0xCC 0xDD
0xEE 0xFF 0xGG 0xHH
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora joined lora joined <status> enabled
Set lora joined
<bool>
lora joined 0 <status> lora joined 0 disabled
Parameter Type Descripon
<bool> Number Network joined status to be set:
0: Unjoined
1: Joined
<status> String Network joined status string. Opons:
enabled: Joined
disabled: Unjoined / Not Joined
ICT INTERNATIONAL Operation Manual EF-NODE
10

3.2.4 LoRaWAN Public Network Mode – lora net public
Command Input: lora net public
Compable: All Device Firmware Versions
Descripon: Enable/Disable public network mode. Change the sync word used by the LoRa radio between the
public and private sengs.
3.2.5 LoRaWAN Adapve Data Rate – lora net adr
Command Input: lora net adr
Compable: All Device Firmware Versions
Descripon: Devices using adapve data rate will query the server periodically to determine the highest data
rate they can transmit at and sll be heard. The LoRaWAN specicaon states that staonary devices should
use ADR, however use on mobile devise is discouraged as it is unlikely to work correctly.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora net public lora net public <status> lora net public enabled
Set lora net public
<bool>
lora net public
0
<status> lora net public 0
disabled
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora net adr lora net adr <status> disabled
Set lora net adr <bool> lora net adr 1 <status> lora net adr 1 disabled
Parameter Type Descripon
<bool> Number Network joined status to be set:
0: Disable
1: Enabled
<status> String Public network status string. Opons:
enabled
disabled
Parameter Type Descripon
<bool> Number Network joined status to be set:
0: Disable
1: Enabled
<status> String Public network status string. Opons:
enabled
disabled
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 11

3.2.6 ADR Link Check Period– linkcheck period
Command Input: linkcheck period
Compable: Device Firmware Versions > 1.2
Descripon: Determines the number of unconrmed packets between link checks when using ADR. Typically,
this is set automacally and should not need to be changed.
3.2.7 LoRaWAN Default Data Rate – lora data rate
Command Input: lora data rate
Compable: All Device Firmware Versions
Descripon: Manage the device’s default data rate. Used when ADR is not enabled.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get linkcheck period linkcheck period <period> 64
Set linkcheck period
<period>
linkcheck period
0
<period> linkcheck period 200
200
Parameter Type Descripon
<period> Number Number of unconrmed packets between link checks.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora data rate lora data rate <data rate> 2
Set lora data rate
<data rate>
lora data rate
0
<data rate> lora data rate 1 1
Parameter Type Descripon
<data rate> Number LoRaWAN Data Rate, where 0 is minimum (LoRa spreading factor 12).
Maximum value is region specic.
ICT INTERNATIONAL Operation Manual EF-NODE
12

3.2.8 LoRaWAN Maximum TX Power – lora tx power
Command Input: lora tx power
Compable: All Device Firmware Versions
Descripon: Manage the device’s default maximum transmit power. This is relave to the maximum EIRP,
which can be changed by the network server aer the device is joined to the network.
The actual maximum transmit power will be the maximum EIRP minus 2 mes this seng, in dBm, unless
that value is above 20 dBm, as that is the maximum power of the device’s radio.
3.2.9 Conrmed Messaging – lora conrmed
Command Input: lora conrmed
Compable: All Device Firmware Versions
Descripon: Enables/Disables LoRaWAN conrmed messaging.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora tx power lora tx power <power> 0
Set lora tx power
<power>
lora tx power 2 <power> lora tx power 2 2
Parameter Type Descripon
<power> Number Maximum transmit power, power below MAX_EIRP.
TX_PWR = MAX_EIRP – 2 x power (dBm)
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora conrmed lora conrmed <string> disabled
Set lora conrmed
<bool>
lora conrmed
0
<status> lora net adr 0 disabled
Parameter Type Descripon
<bool> Number Indicates whether to enable or disable conrmed messaging:
0: Disable
1: Enabled
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 13

3.2.10 LoRa Band
Command Input: lora band
Compable: Device Firmware Versions
Descripon: Sets the LoRaWAN sub-band and default channel mask. Note that band should be set to 2 for
AU915 and US915. Band selecon is not applicable to AS923.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora band lora band <string> lora band
Band set to: 1
Set lora band <band> lora band 2 <string> lora band 2
Band set to: 2
Parameter Type Descripon
<band> Number LoRaWAN Sub-band selecon. Frequency plan dependant.
ICT INTERNATIONAL Operation Manual EF-NODE
14

Command Type Syntax Used Example Command Response Type Example Result of Command
Get lora net abp lora net abp <status> disabled
Set lora net abp lora net abp 1 <status> lora net abp 1 enabled
3.3 LoRaWAN Acvaon-by-Personalisaon Mode
These commands are entered into a terminal or terminal emulator such as Puy, hps://www.puy.org/,
to acon several types of commands to the EF-NODE. In Acvaon-by-Personalisaon mode the device is pre-
supplied with all keys and ideners such that it does not need to undergo an over-the-air join process.
All sengs in this secon are required to be manually set when using Acvaon-by-Personalisaon (ABP) and
will be retrieved during the join process for OTAA devices. Do not change these if using OTAA on the device.
3.3.1 LoRaWAN Acvaon-by-Personalisaon – lora net abp
Command Input: lora net abp
Compable: All Device Firmware Versions
Command Descripon: Enable/Disable Acvaon-by-Personalisaon Mode.
Parameter Type Descripon
<bool> Number Indicates whether to enable or disable abp mode:
0: Disable / 1: Enabled
<status> String ABP mode status string. Opons: enabled / disabled
Type Syntax Used Response Type Example Result of Command
Get lora key session <type> <key> 1122334455667788AABBCCDDEEFFGGHH
Set lora key session
<type> <key>
<key> lora key session app
1122334455667788AABBCCDDEEFFGGHH
1122334455667788AABBCCDDEEFFGGHH
3.3.2 LoRaWAN Session Keys – lora key session
Command Input: lora key session
Compable: All Device Firmware Versions
Command Descripon: Manage the device’s applicaon and network session keys.
Parameter Type Descripon
<key> String 32 character Hexadecimal string represenng an 16-byte EUI. Example:
0x11 0x22 0x33 0x44 0x55 0x66 0x77 0x88 0xAA 0xBB
0xCC 0xDD 0xEE 0xFF 0xGG 0xHH
<type> String Key Types include: app (Applicaon Session Key) nwk (Network Session Key)
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 15

Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora net
dev addr
lora net dev addr <eui> 11223344
Set lora net
dev addr
<eui>
lora net dev addr <eui> lora net dev addr
11223344 11223344
3.3.3 LoRaWAN Device Address – lora net dev addr
Command Input: lora net dev addr
Compable: Device Firmware Versions
Command Descripon: Get/Set the device’s LoRaWAN network address.
Parameter Type Descripon
<eui> String 8 character Hexadecimal string represenng an 4-byte EUI. Examples:
0x11 0x22 0x33 0x44
11223344
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get lora net
id
lora net dev addr <eui> 11223344
Set lora net
id <eui>
lora net dev addr <eui> lora net id
11223344 11223344
3.3.4 LoRaWAN Network Indener – lora net id
Command Input: lora net id
Compable: Device Firmware Versions
Command Descripon: Get/Set the network idener of the connected LoRaWAN network.
Parameter Type Descripon
<eui> String 8 character Hexadecimal string represenng an 4-byte EUI. Examples:
0x11 0x22 0x33 0x44
11223344
ICT INTERNATIONAL Operation Manual EF-NODE
16

3.4 Timing
Commands for managing the device’s state transion mings.
3.4.1 Time to Retransmit – backo inial
Command Input: backo initial
Compable: Device Firmware Versions > 1.2
Command Descripon: Inial wait me on failed communicaons before retrying. Doubles each failure unl
it reaches backo max.
3.4.2 Maximum Retransmit Time aer Failed Communicaon – backo max
Command Input: backo max
Compable: Device Firmware Versions > 1.2
Command Descripon: Maximum wait me on failed communicaons before retrying.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get backo initial backo initial <string> Initial Backo Time: 60
sec
Set backo initial
<time>
backo initial
90
<string> backo initial 90
Initial Backo Time: 90
sec
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get backo max backo initial <string> Maximum Backo Time:
86400 sec
Set backo max
<time>
backo initial
90
<string> backo initial 90000
Initial Backo Time:
90000 sec
Parameter Type Descripon
<me> Number Wait me in seconds.
Parameter Type Descripon
<me> Number Wait me in seconds.
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 17

3.4.3 Period Between Reports – report period
Command Input: report period
Compable: Device Firmware Versions > 1.2
Command Descripon: Inial wait me on failed communicaons before retrying. Doubles each failure unl
it reaches backo max.
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Get report period report period <string> Report Period: 900 sec
Current: 12 Last: 0 Next:0
Set report period
<period>
report period
600
<string> report period 600
Report Period: 600 sec
Current: 26 Last: 0 Next:0
Parameter Type Descripon
<period> Number Time in seconds between reports.
<me> Number Current device mestamp
<last> Number Timestamp that state last triggered at
<next> Number Timestamp of next state trigger
ICT INTERNATIONAL Operation Manual EF-NODE
18

3.5 Unique EF-NODE Commands
Commands for measuring RF Intensity and the device’s baery level.
3.5.1 Send Fence Strength Command – fence strength
Command Input: fence strength
Compable: All Device Firmware Versions
Command Descripon: Provides current RF intensity value which is used as an indicaon of fence pulsing
strength. Use to establish in-situ RF intensity that correspond to electric fence status; e.g. operaonal, tripped
or unpowered states. This command should be used at installaon to establish RF intensity values to indicate
these states in the payload decoder.
3.5.2 Send Baery Test – baery test
Command Input: battery test
Compable: All Device Firmware Versions
Command Descripon: Provides current baery voltage in millivolts. The example 5225 would equate with
5.22 Volts. Device operates to a lower voltage limit of 4.2volts.
3.5.3 Fence Low Alarm – fence threshold
Command Input: fence threshold
Compable: All Device Firmware Versions
Command Descripon: RF Intensity threshold, when value drops below the set value the node triggers a
conrmed message to the network server.
Type Syntax Used Response Type Example Result of Command
Get fence strength <value> STRENGTH=2780
Type Syntax Used Response Type Example Result of Command
Get battery test <voltage> BAT_MV=5225
Command
Type Syntax Used Example Command Response
Type Example Result of Command
Set fence threshold fence threshold
1000
<string> 1000
ICT INTERNATIONAL Enabling better global research outcomes in soil, plant & environmental monitoring 19

4. Decoder Notes
Please contact ICT Internaonal for the EF-NODE decoder applicable to your order and suitable for TTN
(hps://www.thethingsnetwork.org/):
Table of contents