Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
xastir_udp_client(1)	    General Commands Manual	  xastir_udp_client(1)

NAME
       xastir_udp_client  -  send  simple messages to xastir for APRS(tm) net-
       work.

SYNOPSIS
       xastir_udp_client <hostname> <port> <callsign> <passcode> {-identify  |
       [-to_rf]	<message>}

DESCRIPTION
       xastir_udp_client  sends	 packets into the UDP listening	port of	an en-
       abled xastir instance.

EXAMPLES
	xastir_udp_client localhost 2023 <callsign>  <passcode>	 "APRS	Packet
       Goes Here"

       Currently  that	will inject the	packet into Xastir's decoding routines
       and send	it to any TCP-connected	clients. It will also igate it to  the
       INET  if	 you have igating enabled.  It will send the packet out	the RF
       ports as	third-party packets only if you	add the	 "-to_rf"  flag	 after
       the passcode like this:

	xastir_udp_client  localhost  2023  <callsign> <passcode> -to_rf "APRS
       Packet"

       The UDP client is useful	for generating and injecting APRS packets from
       external	scripts.  It can also be used to fetch the callsign of the re-
       mote xastir server by using the -identify flag:

	xastir_udp_client localhost 2023 <callsign> <passcode> -identify

NOTES
       This is a very simple utility that provides no  validation  of  message
       content.	  The  text  passed  as	the last argument is directly injected
       into Xastir's incoming data stream and processed	exactly	as if  it  had
       come out	of a TNC.

       As such,	the text passed	to it as "APRS Packet" must be a complete APRS
       packet, including FROM and TO call signs, not simply the	payload.  Thus
       to have it work properly, you should pass "MYCALL-0>APX219:payload goes
       here"  as  the  string,	not  "payload  goes here" (where obviously you
       should replace "MYCALL-0" with your own callsign	and SSID).

       If the APRS payload provided is an object or item, and  the  call  sign
       and SSID	provided in the	packet header match Xastir's exactly, then Xa-
       stir will "adopt" the object or item and	treat it in the	same manner as
       one  that  had been created in its own GUI --- that is, the object will
       be retransmitted	with decaying intervals	until deleted.	 This  can  be
       useful  if  one wishes to create	objects	external to Xastir and have it
       take control over them, but can be a bit	surprising if you weren't  ex-
       pecting	it.   If you want the objects treated as Xastir's own, use the
       same callsign and ssid for the object as	the callsign/SSID that	Xastir
       is using, and if	you DON'T want that, use a different SSID.

       If  Xastir's callsign is	"MYCALL-0" then	this invocation	will create an
       object that will	be adopted and retransmitted:

	 xastir_udp_client   localhost	 2023	MYCALL-0    <passcode>	  "MY-
       CALL-0>APX219,WIDE2-1:;foobar   *202111z3501.53N/10619.04W/"

       while this invocation will create an object that	will only be transmit-
       ted once	and not	adopted:

	 xastir_udp_client    localhost	   2023	  MYCALL-0   <passcode>	  "MY-
       CALL-1>APX219,WIDE2-1:;foobar   *202111z3501.53N/10619.04W/"

SEE ALSO
       xastir help file

       APRS[tm]	 is  a	Trademark  of  Bob  Bruninga,  his  home  page	is  at
       "http://www.aprs.org/aprs.html"

COPYING
       Copyright (C) 1999,2000 Frank Giannandrea KC2GJS
       Copyright (C) 2000-2023 The Xastir Group

The Xastir Group		  2019-05-01		  xastir_udp_client(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=xastir_udp_client&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help