User Tools

Site Tools


packet:bpq

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
Next revisionBoth sides next revision
packet:bpq [2024/04/04 12:24] – Added tx/rx parameter information mm0uhrpacket:bpq [2024/05/14 17:49] m0lte
Line 141: Line 141:
  
 BPQ has a simple and evolving HTTP REST API. BPQ has a simple and evolving HTTP REST API.
 +It is used though the HTTPPORT (in this example is port 9122)
  
 endpoints: (note older versions were prefixed with 'get' (except request_token) endpoints: (note older versions were prefixed with 'get' (except request_token)
  
 +<code>
 /api/request_token /api/request_token
 /api/ports /api/ports
Line 149: Line 151:
 /api/users /api/users
 /api/info /api/info
 +/api/links
 /api/mheardport/<port#> /api/mheardport/<port#>
 +</code>
  
 Requested like so: Requested like so:
Line 163: Line 167:
 <code>{"callSign": "G7TAJ-15", "port": "1", "packets": 10, "lastHeard": "2024-3-6 17:14:01"  }, <code>{"callSign": "G7TAJ-15", "port": "1", "packets": 10, "lastHeard": "2024-3-6 17:14:01"  },
 {"callSign": "G7TAJ", "port": "1", "packets": 5, "lastHeard": "2024-3-3 15:46:07"  }</code> {"callSign": "G7TAJ", "port": "1", "packets": 5, "lastHeard": "2024-3-3 15:46:07"  }</code>
 +
 +
 +===== Events =====
 +BPQ can fire an executable on certain events.
 +  * new message
 +  * message read
 +  * user joining chat
 +
 +In bpq32.cfg
 +<code>EnableEvents=1</code>
 +
 +For mail events:
 +
 +On the web interface, MailMgmt/Configuration enable:
 +<code>Enable Event Reporting</code>
 +
 +This will call the following in the bpq directory (For Windows add .exe to the filename)
 +
 +<code>MailNewMsg</code>
 +
 + 
 +It will run the following on a message being read:
 +<code>MailMsgRead</code>
 +
 +
 +The format of the output is as a string of arguments to the program:
 +
 +<code>51260 P N 0 G7TAJ G7TAJ 240408 test</code>
 +
 +
 +Chat events:
 +This needs to be configured on the chat Web interface page.
 +
 +<code>ChatNewUser</code>
 +
 +Arguments:
 +
 +''
 +240408-G7TAJ : Steve %%*%%%%*%%%%*%% Joined Chat, Topic General
 +''
 +
  
  
Line 192: Line 237:
 The other is that frequently some nodes cannot see all the other nodes in the network so no matter how long they listen for they cannot hear particular nodes transmitting so will send data to stations that are already receiving and potentially collide. The other is that frequently some nodes cannot see all the other nodes in the network so no matter how long they listen for they cannot hear particular nodes transmitting so will send data to stations that are already receiving and potentially collide.
  
 +===== Monitoring BPQ32 =====
 +
 +BPQ32 can be configured to produce SNMP octet counters for bytes through its ports.
 +
 +See [[packet:linbpq_monitoring|Monitoring LinBPQ through SNMP]]
packet/bpq.txt · Last modified: 2024/05/16 09:02 by g7taj