Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
software:timingunits:tcpimporter [2024/08/09 11:42] henriksoftware:timingunits:tcpimporter [2024/08/29 08:15] (current) henrik
Line 1: Line 1:
-=== Generic TCP importer ===+{{indexmenu_n>100}} 
 + 
 +====== Generic TCP importer ======
  
 Using a very simple text-based TCP protocol, you can have your own devices or integration component connect into BBT, and import raw time records this way, just like any natively supported box. Using a very simple text-based TCP protocol, you can have your own devices or integration component connect into BBT, and import raw time records this way, just like any natively supported box.
Line 5: Line 7:
 You can connect as many devices as you like, with each connection representing a device with an identifier of your choice. You can connect as many devices as you like, with each connection representing a device with an identifier of your choice.
 The default port is 12368, but this can be changed via the advanced event setting //ext.generictcp.inbound.port//. The default port is 12368, but this can be changed via the advanced event setting //ext.generictcp.inbound.port//.
 +
 +{{:software:timingunits:tcpimporter.png|}}
  
 == Protocol format == == Protocol format ==
Line 38: Line 42:
 record.add;ok;id=42 record.add;ok;id=42
  
-Records can be updated using the record.update command. The arguments are the exact same as for record.add, but id is optional.+Records can be updated using the record.update command. The arguments are the exact same as for record.add, but id is required.
 If a record with the provided id does not exist, it might be created. If a record with the provided id does not exist, it might be created.
 +
 +== Device status ==
 +It is possible to send periodic device status information, such as vendor, model, battery information, GPS position, firmware version, read rates and much more. Contact us for details on the supported values.
 +
 +Example command:\\
 +status;device.vendor=My company;device.model=Cool Device Pro;power.battery.available=1;power.battery.pct=53;gps.satellites=7;temp.cpu=42
 +
 +Responses:\\
 +record.status;ok
 +
  
 == Inactivity == == Inactivity ==
Line 50: Line 64:
 Response:\\ Response:\\
 ping;ok ping;ok
 +