Porovnávané verzie

Kľúč

  • Tento riadok sa pridal
  • Riadok je odstránený.
  • Formátovanie sa zmenilo.

...

ParameterDescriptionUnit / sizeDefault Value
Kotva
ct
ct
Connection Type
Type of connection between D2000 KOM process and other party (LoRaWAN gateway, network server, cloud).
Currently supported are:
  • Kerlink IoT Station SPN (JSON via UDP packets): communication with Kerlink IoT Station with firmware SPN (Small Private Network). Line must be of the SerialOverUDP Device Redundant type.
  • MQTT Client (JSON via MQTT): communication with network server or cloud using MQTT protocol. Line must be of the TCP/IP-TCP type.
  • Sigfox Client (JSON via HTTPS): communication with Sigfox cloud
-Kerlink IoT Station SPN
Kotva
mf
mf
Mote Field Name

Name of field with identifier of LoRaWAN device (mote).
Note: For JSON messages that can be structured, the syntax level1.level2.level3 ... is supported e.g. rx.moteeui and if they contain fields (indexed from 1) then also the syntax level1[index1].level2[index2].level3 ... is supported e.g. rx.gwrx[1].time. For examples see description of I/O tags of the Envelope type.
Note: For Sigfox data files, which may contain multiple values (historical), index 0 resp. empty index (e.g. data[].device) can be used. This indicates that all field elements are to be processed.

-rx.moteeui
Kotva
pf
pf
Payload Field Name
Name of field with payload. See the notes next to the Mote Field Name parameter.-rx.userdata.payload
Kotva
pe
pe
Payload Encoding
A method of payload encoding in the message. Supported encoding:
  • Base16 + Base64 encoding (Kerlink SPN) - for Connection Type=Kerlink IoT Station SPN
  • Base64 encoding (TheThings.network) - for Connection Type=MQTT Client communicating with TheThings.network cloud
  • Base64 encoding (Loriot, Slovanet, Sigfox) - for Connection Type=MQTT Client communicating with LoRaWAN clouds (Lorio, Slovanet) as well as Sigfox
  • None - message contains a payload without encoding - not yet used
-Base16 + Base64 encoding
Kotva
tf
tf
Time Field Name
Name of field with time stamp. If the field is not found, the current time is assigned to the values. See the notes next to the Mote Field Name parameter.-rx.gwrx[1].time
Kotva
tm
tm
Time Mask
Mask for parsing a value in field with time stamp.
Note: from settings of time station parameters depends whether the time is interpreted as local or UTC with configured offset.
Special masks are:
  • UNIX - the numeric value represents the number of seconds from epoch 00:00:00 01.01.1970 UTC.
  • UNIXMS - the numeric value represents the number of miliseconds from epoch 00:00:00.000 01.01.1970 UTC.
-yyyy-mm-dd hh:mi:ss
Kotva
ftf
ftf
Frame Type Field Name
The name of field that indicates the message type. If the value is empty, the message type is not distinguished. (For example, cloud Loriot sends messages of a various types.)- 
Kotva
ftv
ftv
Frame Type Field Required Value
If the message type differentiation is active (non-empty value of Frame Type Field Name parameter), the message type must match the specified value, otherwise, the message is ignored.- 
Kotva
fd
fd
Full Debug
Enabling the detailed statements about sending and receiving values.YES/NONO
Parameters specific for Connection Type=MQTT Client.
Kotva
un
un
MQTT User Name
See the description of the User Name parameter in the MQTT protocol documentation.
Kotva
pw
pw
MQTT Password
See the description of the Password parameter in the MQTT protocol documentation.
Kotva
tc
tc
MQTT Topic Filter
See the description of the Topic Filter parameter in the MQTT protocol documentation.+/+/+/up
Kotva
pq
pq
MQTT Subscribe QoS
See the description of the Subscribe QoS parameter in the MQTT protocol documentation.
Kotva
ci
ci
MQTT Client ID
See the description of the Client ID parameter in the MQTT protocol documentation.
Kotva
cs
cs
MQTT Clean Session Flag
See the description of the Clean Session Flag parameter in the MQTT protocol documentation.
Kotva
mp
mp
MQTT Publish Format
Format of JSON message used while writing a value. The content of I/O tag of Write type will be encoded (depending on the Payload Encoding parameter) and inserted into the message, where it will replace the #PAY# string.
The default value "{"port":1, "confirmed":false, "payload_raw":#PAY#} was tested when sending data to cloud TheThings.Network.
-"{"port":1, "confirmed":false, "payload_raw":#PAY#}
Kotva
pq
pq
MQTT Publish QoS
See the description of the Publish QoS parameter in the MQTT protocol documentation.
Kotva
pi
pi
MQTT Ping Interval
See the description of the Ping Interval parameter in the MQTT protocol documentation.
Kotva
rt
rt
MQTT Reply Timeout
See the description of the Reply Timeout parameter in the MQTT protocol documentation.
Kotva
wt
wt
MQTT Wait Timeout
See the description of the Wait Timeout parameter in the MQTT protocol documentation.
Kotva
mwr
mwr
MQTT Max. Wait Retry
See the description of the Max. Wait Retry parameter in the MQTT protocol documentation.

...

Line parameters tested for Connection Type=Sigfox Client (JSON via HTTPS) towards Sigfox cloud

...

ParameterDescriptionUnitDefault Value
Kotva
dt
dt
Device Type
Type of device. Each device type may have its own structure of transmitted data (payload). The list of supported devices will gradually increase.
Currently supported devices are:
  • None - no device
  • OEM device - payload parsing is performed by an external dll library
  • Adeunis RF Field Test Device - test device sending GPS position data and temperature data
  • SolidusTech IndoorUNI Sensor - indoor temperature and humidity meter
  • SolidusTech miniUNI DS18B20 Sensor - temperature meter for outdoor use
  • Adeunis RF LoRaWAN TEMP (ARF8180BA) - temperature meter for outdoor use with two independent temperature sensors
  • Codea WZU-SG (Landis+Gyr Ultraheat T550) - radiomodule WZU-SG by Codea for heat meter Landis+Gyr UH50/UC50/T550
-None
Kotva
ed
ed
External Dll Name
Name of external DLL library with code for payload parsing for Device Type=OEM device.- 
Kotva
nd
nd
No Data Timeout
Timeout after which the station goes into communication error state if no data has been received.hh:mi:ss01:00:00

Kotva
mt
mt
MQTT Topic (for writing)

Topic used when writing the value (for Connection Type=MQTT client).
Note: for ipesoft-test user and fieldtestdevice device writing was tested towards TheThings.network with MQTT_TOPIC=ipesoft-test/devices/fieldtestdevice/down.
- 

Kotva
dc
dc
Sigfox Download Command File

For Sigfox: path to the file for downloading data from the Sigfox cloud to the input directory (specified by parameter Input file of the File I/O line) together with possible parameters. The path may contain (like the Input File parameter) the symbolic constant #APPDIR# (application directory) as well as #ADDR# (station address) so that a single file can be used to handle multiple stations.
Example for Windows: #APPDIR#/Sigfox_cmd/get.bat #ADDR#
Example for Linux: /bin/sh #APPDIR#/Sigfox_cmd/get.sh #ADDR#
Note: this parameter does not have to be entered if an independent mechanism is used to download the data.

The download itself can use the curl utility to perform a HTTPS GET query against the sigfox web server.

Example for Windows platform - file get.bat (download is via proxy server, server identity verification is disabled, xxx:yyy is user name and password for Sigfox cloud):

rem default count=1, possible to download upto 100 values
set count=1
rem ID of device is 1st parameter
set id=%1
c:\utils\curl.exe  --proxy http://proxy:3128 --insecure -u xxx:yyy -o msg_%id%.txt https://backend.sigfox.com/api/devices/%id%/messages?limit=%count%

Example for Linux platform - file get.sh (it is necessary to explicitly specify that files are downloaded e.g. to Sigfox_input directory):

#/bin/sh# default count=1, possible to download upto 100 values
count=1
base=$(dirname "$0")
#ID of device is 1st parameter
id=$1
#name of downloaded data file (including directory)
datafile=$base/../Sigfox_input/msg_$id.txt
/usr/bin/curl --proxy http://proxy:3128 --insecure -u xxx:yyy -o $datafile https://backend.sigfox.com/api/devices/$id/messages?limit=$count


Note: if command files are edited prior to running KOM process, parameter count can be increased upto 100, resulting in downloading not only the latest value, but also previous (upto 99) historical values. Then, after the first polling, parameter count can be decreased to 1.



Kotva
t
t
Sigfox Download Timeout

For Sigfox: timeout for downloading data via Sigfox Download Command File. If downloading takes longer, station will go to error.sec30

...