Test protocol

generic
Protocol designed for demonstration and testing purposes. Connection to a channel via this protocol allows emulating interaction between a device and flespi gateway.
flespi parses the Test protocol messages into a JSON object with the fields listed below in the Parameters tab.
Access parsed data via MQTT & REST API Send commands to configure devices Check protocol changelog
All protocols
Usage specifics Parameters (10) Commands (1) Changelog

Test protocol by Gurtam used for demonstration and testing purposes.

Connection to channel with given protocol allows to emulate interaction between device and flespi gateway. Connect to the channel's IP:port via telnet-like tool. The following options are available:

  1. set an ident (to emulate device-like interaction connection can be identified with device's unique string)
  2. register messages (emulates registration of up to 1K messages from emulating device)
  3. switch to eсho mode (connection will reply with received data to any incoming message)

Detailed instructions on how to try this protocol available in flespi 10 minutes play guide.

Bash example:

(echo "1";
 echo "ident";
 echo "2";
 echo "1";
 echo '{"ident": "ident","timestamp": 1702366832.965264,"message.type": "example","driver.message": "Hello, flespi!"}';
 sleep 1;
 echo "0";) | telnet <your.channel.host> <your_channel_port> | grep Connected

Please replace <your.channel.host> and <your_channel_port> with YOUR test channel credentials.

Name
Type
Unit
Description
Sources
channel.id
number
ID of channel that received a message
custom
number
Any custom parameter
device.id
number
ID of device that received a message
device.name
string
Name of device that received a message
device.type.id
number
ID of device type of device that received a message
ident
string
Device unique identifier like serial number, IMEI, etc
peer
string
IP:port from which device connecting to the channel
protocol.id
number
ID of protocol
server.timestamp
number
seconds
Timestamp when server received a message
timestamp
number
seconds
Message timestamp
Title
Name
Description
Properties
Send custom command
custom
Send command with any parameters using connection to channel