Menu Close

UDP interface for external client software

Text and position messages which are sent via LoRa-RX or UDP input from the MeshCom server to the external UDP interface as JSON protocol and text messages which are sent from the external UDP interface to the LoRa-TX or UDP are sent to the MeshCom server.

Protocol of the external interface

  • send to the external client vai UDP port 1799
    • Positions
      • {„src_type“:“node/udp/lora", "type":"pos„,“src“:“<source_path>“,“msg“:““,“lat“:<lat>,“lat_dir“:“N/S",
        „long“:<lon>,“long_dir“:“W/E„,“aprs_symbol“:“<SYM>“,“<aprs_symbol_group>“:“<GROUP>“,
        „hw_id“:“<MAC>“,“msg_id“:“<msg_id>“,“alt“:<alt>,“batt“:<batt_proz>,“firmware“:“<fw_num>“,“fw_sub“:“<fw_sub>"
        }

        • node...message comes from LoRa-RX
        • udp...message comes from the MeshCom server
        • lora...message comes from LoRa-RX
        • msg_id...is displayed as hexadecimal
        • fw_num...Firmware of the node
        • fw_sub...Firmware Subinfo a-z
    • Text messages
      • {„src_type“:“node/udp/lora„,“type“:“msg„,“src“:“<source_path>“,
        „dst“:“<destination_path>“,“msg“:“<payload>“,“msg_id“:“<msg_id>“,“firmware“:“<fw_num>“,“fw_sub“:“<fw_sub>“}
        • node...message comes from LoRa-RX
        • udp...message comes from the MeshCom server
        • lora...message comes from LoRa-RX
        • fw_num...Firmware of the node
        • fw_sub...Firmware Subinfo a-z
  • received from the external client
        • Text messages
          • {„type“:“msg„,“dst“:“<destination_path>“,“msg“:“<payload>“}
  • Definitions
    • <source_path> ein oder mehrere Rufzeichen
      • Examples:
        • OE1ABC-1
          • This callsign was heard directly
        • OE1ABC-1,OE1XOR-12
          •  OE1ABC-1 was heard via OE1XOR
    • <destination_path>
      • to All
        • * (star)
      • to a group
        • 10...99999 (two to 5 digits)
      • to a direct callsign
        • OE1KBC-12
    • <payload>
      • valid UTF-8 character set
      • max. 150 characters
    • <msg_id>
      • Unique message number
        • Should consist of MAC address and at least 3-digit consecutive number
    • <lat>
    • <lon>
      • Latitude and longitude in 99.9999 decimal notation
    • N/S
    • W/E
      • Definition of the quadrant in which the geo-position data applies.
    • APRS symbols according to APRS symbol table
    • <batt_proz>
      • 0-100

Activation of the external UDP interface:

The UDP port is activated via the node's USB interface:

  • Connection parameters to external client
    • --extudpip 255.255.255.255
  • Activate UDP port 1799
    • --extudp on

 

  • Deactivate UDP port 1799
    • --extudp off

Other necessary settings

The WiFi interface must be defined so that a UDP interface can be established.

  • -setssid WIFIssid
  • -setpwd WIFIpassword

If your own WiFi interface does not receive the IP address via DHCP from the WiFi router (AP), this can also be fixed.

  • -setownip 255.255.255.255
  • -setowngw 255.255.255.255
  • -setownms 255.255.255.255

The manually assigned IP address must be one from the home network, which is free. The gateway must be the address of the WiFi router. The mask must be set to match the home network.