API reference wtSock (client HamDXMap)

wtSock, websocket server Help

wtSock is a local websocket server. wtSock allows you to connect Win-Test (any instance on your network) and send back network frames in JSON format to the connected client. It is especially useful to send on-the-fly entries, confirmed contacts (recorded QSOs) and DXCluster spots (wtDxTelnet) to the application HamDXMap (dxmap.f5uii.net) or other type of client software.

Below you will find details of settings and incoming and outgoing message formats.

Port inboud

Wintest is able to broadcast of network information in realtime. Report here the port that you can read in Options / Interfaces configuration / Local Network / Port number

Port outbound

The data are transmitted to the websocket client over this port. By default 8080 is used. as this application does not broadcast in https, your client will have to be on the same host as wtSock (localhost).

Output messages

LoggedCall

wtSock will send the data when a new QSO is logged by a user in Win-Test.

                            
{
  "Frame": "LoggedCall",
  "Call": "F5UII",
  "Frequency": 14260.5,
  "DateTime": 1682260914,
  "SourceAddr":"192.168.1.32:9871"
}
                        

• The Frame identify the message type.
• Call is the callsign logged.
• Frequency is the logged frequency.
• DateTime is UTC unix timestamp format sended by Win-Test (*)
• SourceAddr is ip:port of the source (*)

Live keyboarding

wtSock will send the partial callsign letter after letter when the user is keying in Win-Test.

                            
{
  "Frame", "PartialCall"
  "Call": "F5U",
  "DateTime": 1682260914,
  "SourceAddr":"192.168.1.32:9871"
}
                        

• The Frame identify the message type.
• Call is the raw keyed callsign or partial callsign.
• DateTime is UTC unix timestamp format sended by wtSock (*)
• SourceAddr is ip:port of the source (*)

DXCluster

wtSock will send the data when a new QSO is logged by a user in Win-Test.

                            
{
  "Frame": "DXSpot",
  "Spotter": "HZ1BH",
  "Spot": "DJ2IT",
  "Frequency": 14004,
  "Comments": "599 In W/ksa Gdx 2105Z",
  "DateTime": 1682283905,
  "SourceAddr": "192.168.1.32:9871"
}
                        

• The Frame identify the message type.
• Spotter is the callsign of the spotter.
• Spot is the callsign of the DX Station.
• Frequency is the frequency where you will hear the DX station.
• Comments is the spotter comments with the original Time UTC HHMM.(*)
• DateTime is UTC unix timestamp format sended by wtSock (*)
• SourceAddr is ip:port of the source (*)

Gab

wtSock will send all the Gab messages (Alt-G) typed in by user on Win-Test.

                    
{
  "Frame", "Gab"
  "From",  "STN1" },
  "To",  "STN2" },
  "Message", "Hi \"KH6KK\"" may call you" },
  "DateTime": 1682260914,
  "SourceAddr":"192.168.1.32:9871"
}
                

• The Frame identify the message type.
• From is the Win-Test station name sending the message.
• To is the Win-Test station name receiving the message. Can be empty when message is delivered for all the WIn-Test stations.
• DateTime is UTC unix timestamp format sended by wtSock (*)
• SourceAddr is ip:port of the source (*)

Releases

wtSock software is designed to communicate with HamDXMap (dxmap.f5uii.net). The JSON stream can be used by other software programs that would like to interface with Win-Test.

- 1.0.0.0 : 15/06/2023 - First release with LoggedCall, Keyboarding, DXCluster, Gab