Pikkerton XBS-200 User manual

XBS-200
User Manual
Version 02
History
Version Date Changes Status
01 12.07.2019 Born
02 15.04.2020 Various A aptions & 1st Release Release
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 1/21

XBS-200
User Manual
Version 02
Legal
© 2019 pikkerton GmbH
All rights, inclu ing translation into foreign languages, are reserve . No part of this publication may be
repro uce in any form (by printing, photocopying or any other metho ) or processe using electronic
systems, copie or istribute without the written permission of pikkerton GmbH. The passing on an
copying of this ocument, use an communication of its contents are prohibite unless explicitly
permitte . Violators are liable for all amages. All rights reserve in the event of patent, utility mo el
or esign. pikkerton GmbH is not liable for technical or e itorial errors or omissions containe herein.
Furthermore, they shall not be liable for any amages that are irectly or in irectly attributable to the
furnishing, performance or use of this material.
Changes to the content herein is subject to change without notice. The Information in this publication
is given without responsibility for accuracy an completeness. In particular, it contains no such
information to be guarantee . The user carries all risk arising from the use of this information.
Please note that all manual software an har ware names, an tra emarks of the respective
companies are generally subject to tra emark, bran or patent protection.
pikkerton GmbH
Wohlrabe amm 16 Fon [phone]
13629 Berlin Fax [phone]
Germany Website www.pikkerton. e
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 2/21

XBS-200
User Manual
Version 02
Table of Contents
1 Har ware / Device.........................................................................................................4
1.1 Sensors an power supply recommen ations................................................................5
1.2 Power Supply..............................................................................................................5
1.2.1 External Power Supply..............................................................................................5
1.2.2 Battery Operation.....................................................................................................6
1.3 Reset.........................................................................................................................8
1.4 LEDs..........................................................................................................................8
1.5 Pushbutton.................................................................................................................8
2 File System....................................................................................................................9
2.1 Secure Partition..........................................................................................................9
2.2 R/W Partition..............................................................................................................9
3 Measurement...............................................................................................................10
4 Configuration via the USB Console................................................................................12
4.1.1 Settings of the Serial Connection.............................................................................12
4.1.2 File Uploa .............................................................................................................12
4.1.3 Rename/Move Files................................................................................................13
4.1.4 Cat files.................................................................................................................13
4.1.5 Show hex umps of a file.........................................................................................13
4.1.6 Check sensor values...............................................................................................13
4.1.7 Activate/ eactivate sensors.....................................................................................14
4.1.8 Dump settings........................................................................................................14
4.1.9 Configure MSI/TXT.................................................................................................15
4.1.10 Delete log files....................................................................................................15
4.1.11 Show system information.....................................................................................15
5 WAN Mo em (Quectel BG96)........................................................................................16
5.1 Start Scripts..............................................................................................................16
5.2 Testing the script......................................................................................................17
6 Settings.......................................................................................................................18
6.1 Common settings in the configuration files.................................................................18
6.2 Change settings via the console.................................................................................21
6.3 Remarks...................................................................................................................21
6.3.1 lwm2m_server.......................................................................................................21
6.3.2 m_broker_a ress..................................................................................................21
6.3.3 m_ct an m_nct.....................................................................................................21
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 3/21

XBS-200
User Manual
Version 02
1 Hardware / Device
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 4/21

XBS-200
User Manual
Version 02
1.1 Sensors and power supply recommendations
For following sensor an communication options a permanent power supply is recommen e :
•WLAN Communication
•Laser base people counting
•VOC Sensor
1.2 Power Supply
The XBS-200 can be supplie via various internal an external sources:
•Internal: with 1.5V / 3.6V AA batteries,
•External: via the 5V USB interface or a separate 12-24V input
1.2.1 External Power Supply
- USB
A 5V USB power supply is require . The connector on the evice si e is Mini-USB-B.
For evices with LTE mo em in GSM mo e, a 2.0 Amp power supply unit is require ,
otherwise a 1.0 Amp mo el is sufficient.
For configuration, the XBS-200 can be supplie from the PC via the USB connection. Please
note the higher current consumption in GSM mo e. The 2.0Amp. woul have to be provi e
by the PC in this case, otherwise the XBS-200 oesn’t boot properly.
- External power supplies
The XBS-200 can be supplie with an external voltage of 12-24V via the green connector. This
option is not available in all har ware configurations.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 5/21

XBS-200
User Manual
Version 02
1.2.2 Battery peration
The XBS-200 can be equippe with commercially available 1.5V AA cells (Mignon, IEC: R6 /
R14505), but 3.6V AA lithium cells are recommen e . The har ware configuration etermines
which cells can be use an is marke with a sticker un er the battery hol ers.
An incorrect battery configuration can amage the evice.
Possible battery configurations:
Battery type: Qty. of cells: Use socket:
1.5V 2 BATT1,BATT3
1.5V 4 BATT1, BATT2, BATT3, BATT4
3.6V 1 BATT1
3.6V 2 BATT1, BATT2
3.6V 3 BATT1, BATT2, BATT3
3.6V 4 BATT1, BATT2, BATT3, BATT4
Battery replacement:
Open the evice by removing the 4 screws on the un ersi e of the evice. A TORX screw river size
T8 is require .
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 6/21

XBS-200
User Manual
Version 02
The housing can now be ismantle into the lower part with boar s, frame an cover.
Now replace the batteries an pay attention to correct polarity! The polarity is printe on the circuit
boar un er the batteries. Reverse polarity can lea to the estruction of the evice, the batteries an
the risk of injury!
As soon as the batteries are inserte , the XBS-200 starts. The assembly is one in reverse or er.
After the evice has been reassemble , please reset the evice.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 7/21

XBS-200
User Manual
Version 02
1.3 Reset
The XBS-200 can be restarte using the button or a software comman .
-Button
The evice has a button with which measurements an a reset can be triggere . To initiate a
reset, press the button for at least 10 secon s. All LEDs on the evice go out. The XBS-200
restarts, the blue LED1 lights up uring the boot phase.
-Software
The evice can be restarte via the console using the reset comman
console> reset
The XBS-200 acknowle ges this with:
Restarting XBS-200!
The XBS-200 restarts, the blue LED1 lights up uring the boot phase.
-USB
If the XBS-200 is operate with batteries, a reset is necessary to activate the USB interface.
USB is eactivate in battery mo e to save power.
Connect the USB cable to the PC an the XBS-200 an trigger a reset with the button. After
the reset, the XBS-200 starts in USB mo e. If the USB cable is remove , the XBS-200
automatically triggers a reset to restart in battery mo e.
1.4 LEDs
The XBS is equippe with 2 RGB-LEDs.
Solid n Flashing
LED1 Red Coul not sen ata to broker (MQTT)
LED1 Green Data sen ing OK (MQTT)
LED1 Blue Booting
LED2 Red
LED2 Green Measurement in progress
LED2 Blue
1.5 Pushbutton
A short push onto the button starts a new measurement interval, regar less of the TXT or MSI cycle.
All sensor values are going to be transmitte imme iately. Pressing the button longer than 10s causes
a har ware reset / restart.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 8/21

XBS-200
User Manual
Version 02
2 File System
There is a file system on the XBS which contains two partitions.
2.1 Secure Partition
This partition is use to store general settings an script files.
2.2 R/W Partition
This partition is use for log files an as file uploa storage.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 9/21

XBS-200
User Manual
Version 02
3 Measurement
The firmware ifferentiates between two main cycles / intervals:
•TXT
•MSI
A TXT interval forces the controller subsystem to wakeup, to take fresh sensor values an sen these
ata imme iately to the respective receiver. The controller is going into eep sleep state afterwar s.
The MSI forces also the controller subsystem to wakeip, to take fresh sensor values an qualify
whether pre-configure threshol s are violate or not. If none of the threshol s are violate , the
controller will enter eep sleep mo e without sen ing anything. The threshol s can be either MIN or
MAX values or also DELTA values. The elta values are generate between the respective last an the
actual measurement an are positive [ abs() ]. If the threshol violation is heale , a 2n telegram will
be sent in or er to notify the receiver of this event as well.
A short MSI cycle with a long TXT cycle can therefore combine both, almost realtime ata in case of
emergency or the nee for alerting an longest battery lifetime.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 10/21

XBS-200
User Manual
Version 02
Identifier
Sensor LWM2M MQTT Topic Unit
Temperature /3303/0/5700 xbs-200/<Serial>/TEM °C
Humidity /3304/0/5700 xbs-200/<Serial>/HUM %
Brightness /3301/0/5700 xbs-200/<Serial>/BRI Lux
UV-Index /3301/1/5700 xbs-200/<Serial>/UVI %
Air Pressure /3315/0/5700 xbs-200/<Serial>/PRES Pa
C 2 /3325/0/5700 xbs-200/<Serial>/CO2 ppm
TV C /3325/1/5700 xbs-200/<Serial>/TVOC mg/m^3
EC 2 /3325/2/5700 xbs-200/<Serial>/ECO2 ppm
C NTACT State /3200/0/5500 xbs-200/<Serial>/CONTACT
PULSE Counter /3200/0/5501 xbs-200/<Serial>/PC
PIR /3200/1/5501 xbs-200/<Serial>/MOVE
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 11/21

XBS-200
User Manual
Version 02
4 Configuration via the USB Console
This escription is base on an Ubuntu System with minicom installe .
Ubuntu 16.04.6 LTS
minicom ersion 2.7 (kompiliert am Nov 15 2018)
Main features of the console:
•File uploa
•Rename/Move files from r/w to secure partition
•Cat files
•Show hex umps of a file
•Execute bg96 start scripts
•Check sensor values
•Activate/ eactivate sensors
•Dump settings
•Configure msi/txt
•Delete log files
•Show system informations
The comman 'help' or '?' prints a short list of all known comman s.
4.1.1 Settings of the Serial Connection
Device: /dev/ttyACM<x>
Connection: 115200 8N1
Connect with minicom an press enter to see if the console is working properly. It happens sometimes
that the USB- river coul not connect to the XBS. If the mesg reports an error please reboot the
Linux system. Then the connection work properly again.
4.1.2 File Upload
Start the minicom in this irectory where the file for uploa is locate .
Enter the comman 'write' the filename for xbs an the file size in Bytes. The filename can be
ifferent from the name on the linux host system.
console> write at.txt 607
1. press <crtg>+<a> then <s>
2. from the uploa menu select xmo em
3. select the file from the Linux file system
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 12/21

XBS-200
User Manual
Version 02
4.1.3 Rename/Move Files
Rename files:
console> mv old.txt new.txt
Move files to the secure-partition:
console> sec file.txt
4.1.4 Cat files
Useful to check Log-Files:
console> cat system.log
4.1.5 Show hexdumps of a file
console> hex system.log
4.1.6 Check sensor values
Displays the current sensor ata for all existing an activate sensors.
console> sensors
BRI: Sensor not active
U I: Sensor not active
PRES: 101839.695 Pa
TEM: 25.528 °C
HUM: 25.993 %
ECO2: 400.000 ppm
T OC: 0.000 ppm
ACC: Sensor NOT FOUND!!!!!!!!!
Not existing sensors are marke with : Sensor NOT FOUND!!!!!!!!!
Not activate sensors are marke with : Sensor not active.
If sensors are activate / eactivate , a reset is necessary to make the apply changes. After a reset
the sensors-comman shows up ate informations.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 13/21

XBS-200
User Manual
Version 02
4.1.7 Activate/deactivate sensors
The existing sensors can be activate an eactivate via the console, the changes are permanent
an are save in the sensors.txt.
console> set pres_enable=on
pres_enable"="on": OK
The comman is confirme by the XBS-200 with the return of the set value.
The list of the supporte sensors varies epen ing on the firmware version an not all sensors are
available in all har ware variants.
All e itable values can be isplaye using the DUMP comman (see ump settings).
4.1.8 Dump settings
All variables can be isplaye using the DUMP comman . Variable names are require , for example, to
activate / eactivate in ivi ual sensors or to change system settings. The isplaye values correspon
to the efault values an not the current values.
console> dump
example 1:
..
pres_enable,onoff,on,Enables the air pressure sensor
..
Variable “pres_enable”, type: onoff, efault-value: on.
(see activate/ eactivate sensors)
example 2:
..
serial,const_string,XSB200010000,Serial
..
Cannot be change , recognizable by “const” (constant).
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 14/21

XBS-200
User Manual
Version 02
4.1.9 Configure MSI/TXT
The measurement (MSI) an transmission (TXT) interval can be configure via the console, the
changes are permanent an are save in the settings.txt.
console> set msi=30
"msi"="30": OK
console> set txt=600
"txt"="600": OK
The value is given in minutes. The comman is confirme by the XBS-200 with the return of the set
value.
4.1.10 Delete log files
After installation, after changing the battery or changing the configuration, it may make sense to
elete the Log-Files in or er not to unnecessarily inflate the files with false alarms.
console> rm system.log
Delete file successful
LOG files in the R/W partition can be safely elete without affecting the functionality of the
evice.
4.1.11 Show system information
Displays information such as evice type, serial number an firmware version.
console> info
PID: XBS-200
Serial Number: XBS200010012
Firmware ersion: 0.13_nb-iot
Build Date: 08:01:01 - Apr 7 2020
Prozessor ID: 0x461
Prozessor Name: STM32L496ZGT
Prozessor Rev: 0x2000
Prozessor UUID: 0x3932211 0x1464029189 0x540227912
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 15/21

XBS-200
User Manual
Version 02
5 WAN Modem (Quectel BG96)
5.1 Start Scripts
After a reset/power on, the XBS starts the BG96 an checks whether it answers to an AT comman .
The BG96 is configure by a script. This script has one comman per line. The coman has two
parameters seperate by a comma. The line en ing enco ing can be UNIX, MAC an Win ows. If a
line starts with an '#' the line will be ignore . Here is an example for NB-IOT with 1nce:
# Script for connecting with 1nce.de via nb-iot
#
#
# No left free spaces after the command is allowed. The sytax:
# <timeout [ms]>,<at command><cr><lf>
#
# At least a <cr> or <lf> must be placed at the end of a line.
# Emplty lines are allowed.
#
# Max script file size 3000kB
# NB1 only, no M1
300,AT+QCFG="iotopmode",1,1
# use LTE technology with GSM fallback
300,AT+QCFG="nwscanmode",0,1
# Network Searching Sequence NB1>GSM>M1
300,AT+QCFG="nwscanseq",030102,1
# for 1nce Europe
300,AT+QCFG="band",0,0,80,1
# connect to 1once nb
180000,AT+COPS=1,2,"26201",9
# activate context 1 for internet communication
180000,AT+QICSGP=1,1,"iot.1nce.net"
The firmware expects a running internet connection on context i 1 (see the last comman for e.g.
1nce).
The name of the script in the XBS must be at.txt
It can be locate in the secure an r/w partition.
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 16/21

XBS-200
User Manual
Version 02
5.2 Testing the script
The scripts can be teste via the console. In this case the script name must be given as parameter, so
that ifferent scripts from at.txt can be teste .
console> exec_at at-test.txt
After the execution is finishe , there is a log-file available, consisting of the comman s an the
answers of the BG96 mo ule. Here is the log from the at.txt above:
console> cat atCommand.log
AT+QCFG="iotopmode",1,1
OK
AT+QCFG="nwscanmode",0,1
OK
AT+QCFG="nwscanseq",030102,1
OK
AT+QCFG="band",0,0,80,1
OK
AT+COPS=1,2,"26201",9
OK
If the script is working properly an shoul be use as start script, rename it to 'at.txt' an move it
to the secure partition. The script name can be change by the setting qt_start_script
console> mv at-test.txt at.txt
OK
console> ls
->Secured files:
settings.txt
->Unsecured files:
at.txt
console> sec at.txt
secure file success
console> ls
->Secured files:
at.txt
settings.txt
->Unsecured files:
console>
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 17/21

XBS-200
User Manual
Version 02
6 Settings
The settings of the XBS are manage by text base configuration files.
The line en ing must be in UNIX style an must not contain empty lines.
The setting files must be places in the secure partition.
The syntax of the settings is:
<id>,<type>,<setting>,<description><0x0a>
6.1 Common settings in the configuration files
settings.txt
serial const_string Serial
variant const_int Variante
hw_version const_int Har ware Version
low_bat int Low battery alert threshol [mV]
msi int Measurement Intervall [s] 0 = off
txt int Sen ing Intervall [s]
ot int Device online time after last packet (in psm mo e) 0..120
[s]
max_logfile_size const_int max logfile size (Bytes)
bg96_enable onoff Enables the bg96 mo ule
bg96_psm onoff Enables psm of the bg96 mo ule
wifi_enable onoff Enables the wifi mo ule
ble_enable onoff Enables the ble mo ule
wmbus_enable onoff Enables the Wireless-MBus mo ule
wmbus_tmo e onoff on: T1-Mo e Chan 11; off: S1-Mo e Chan 10
qt_start_script string Name of the at comman start script
qt_wake_script string Name of the at comman wake script
lwm2m_enable onoff Lwm2m On/Off
lwm2m_queue_enable onoff Lwm2m Queue Mo e On/Off
lwm2m_online_time int Client online time in queue mo e [s]
lwm2m_server string Lwm2m Server URL
lwm2m_server_short_i int Short ID of the Lwm2m Server
mac_ap const_string MAC-A ress of Access Point
mac_st const_string MAC-A ress of Station
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 18/21

XBS-200
User Manual
Version 02
esp_up ate onoff Up ate the ESP via Clou
esp_max_payloa const_int Max TCP Payloa of the WLAN mo ule
esp_up ate_ping string Ping for Up ate to check Web Connectivity
esp_max_rf const_int Max. RF Power [0..11]
mqtt.txt
m_client_enable onoff Custom MQTT-Client Enable
m_broker_a ress string Brokers Host A ress
m_broker_port int Brokers Host Port
m_client_i string MQTT Client ID
m_user string MQTT Username
m_passw string MQTT Passwort
m_sen _base_topic string Topic to sen
m_nct int Break between two connections[min]
m_ct int Onlinetime before isconnecting [min]
sensors.txt
bri_uv_enable onoff Enables the brightness/uv sensor
bri_lt float Lower Threshol for BRI [0.0 lux .. 10000.0 lux]
bri_ht float Upper Threshol for BRI
bri_ elta float Delta Threshol for BRI
uv_lt float Lower Threshol for the UV-In ex [0.0% .. 100.0%]
uv_ht float Upper Threshol for the UV-In ex [0.0% .. 100.0%]
uv_ elta float Delta Threshol for the UV-In ex [0.0% .. 100.0%]
co2_enable onoff Enables the CO2 sensor - not implemente yet
co2_lt int Lower Threshol for CO2 [400ppm .. 60000ppm]
co2_ht int Upper Threshol for CO2 [400ppm .. 60000ppm]
co2_ elta float Delta Threshol for CO2 [0ppm .. 60000ppm]
eco2_enable onoff Enables the eCO2 sensor
eco2_lt float Lower Threshol for eCo2 [400.0ppm .. 10000.0ppm]
eco2_ht float Upper Threshol for eCo2 [400.0ppm .. 10000.0ppm]
eco2_ elta float Delta Threshol for eCo2 [0.0ppm .. 10000.0ppm]
tvoc_lt float Lower Threshol for eCo2 [0.0 .. 10000.0]
tvoc_ht float Upper Threshol for eCo2 [0.0 .. 10000.0]
tvoc_ elta float Delta Threshol for eCo2 [0.0 .. 10000.0]
pres_enable onoff Enables the air pressure sensor
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 19/21

XBS-200
User Manual
Version 02
pres_lt float Lower Threshol for Air Pressure [0.0Pa .. 1000000.0Pa]
pres_ht float Upper Threshol for Air Pressure [0.0Pa .. 1000000.0Pa]
pres_ elta float Delta Threshol for Air Pressure [0.0Pa .. 1000000.0Pa]
tem_hum_enable onoff Enables the temperature/humi ity sensor
tem_lt float Lower Threshol for Temperature [-40.0°C ..
125.0°C]
tem_ht float Upper Threshol for Temperature [-40.0°C ..
125.0°C]
tem_ elta float Delta Threshol for Temperature [-40.0°C .. 125.0°C]
hum_lt float Lower Threshol for Humi ity [0.0% .. 100.0%]
hum_ht float Upper Threshol for Humi ity [0.0% .. 100.0%]
hum_ elta float Delta Threshol for Humi ity [0.0% .. 100.0%]
mov_enable onoff Enables the moving sensor (PIR)
mov_qt int Quietness time for Move Messages[s]
pc_enable onoff Enables the pulse counting
pc_value int Last pulse counter value
contact_enable onoff Enables the contact monitoring
pc_contact_ bt int Debounce time of the pulse counter [ms]
wlan.txt
ip_ap ip IP A ress of of Grannyguar
ip_st ip (station mo e) IP A ress
sn_ap ip (AP mo e) Subnet Mask
sn_st ip (station mo e) Subnet Mask
gw_ap ip (AP mo e) Gateway
gw_st ip (station mo e) Gateway
hcp_ap onoff (AP mo e) DHCP On/Off
hcp_st onoff (station mo e) DHCP On/Off
ssi _ap ascii (AP mo e) SSID of own Access Point
ssi _st ascii (station mo e) SSID of Access Point to connect to
pw_ap ascii (AP mo e) Passwor of own Access Point
pw_st ascii (station mo e) Passwor of remote Access Point
enc_ap int (AP mo e)(Encryption) 0: Off, 2: WPA_PSK, 3: WPA2_PSK,
4: WPA_WPA2_PSK
chan_ap int (AP mo e)channel ID
maxcon_ap int (AP mo e)maximum number of Stations to which AP can be
connecte
ssi _hi en_ap int (AP mo e)0: SSID is broa caste , 1: Hi en
© 2020 pikkerton GmbH XBS-200_Manual_v02.o t Page 20/21