mirror of
https://github.com/ShaYmez/pYSFReflector.git
synced 2024-11-19 06:31:56 -05:00
75 lines
2.3 KiB
Markdown
75 lines
2.3 KiB
Markdown
|
# API-Call Documentation
|
||
|
|
## Introduction
|
||
|
|
As many of us know YSFReflectors use the YSF protocol to communicate with endpoints. These original commands are well
|
||
|
|
documented at http://ycs-wiki.xreflector.net/doku.php?id=start:protocols:ysf thanks to the YCS-team for hosting them.
|
||
|
|
pYSFReflector has also an extended set of commands you can use for fetching infos on the state of different things
|
||
|
|
when running the reflector.
|
||
|
|
|
||
|
|
This document will show the commands and the replys expected from the reflector.
|
||
|
|
|
||
|
|
## How To Issue A Call
|
||
|
|
First of all, it is very easy to have a command sent to a reflector. Simply use a command similar to this:
|
||
|
|
|
||
|
|
`echo -n "YSFS" | nc -u 127.0.0.1 42000 -w 2 && echo`
|
||
|
|
|
||
|
|
or in a more general form:
|
||
|
|
|
||
|
|
`echo -n "<COMMAND>" | nc -u <IP-ADDRESS_OF_REFLECTOR> <PORT_OF_REFLECTOR> -w 2 && echo`
|
||
|
|
|
||
|
|
This line will send the chosen command to the reflector and prints out it's reply.
|
||
|
|
|
||
|
|
## List Of Extended API-Commands
|
||
|
|
Here we will not describe the standard-commands in the YSF protocol but the extended commandset by the pYSFReflector.
|
||
|
|
|
||
|
|
The format of the answer will be the corresponding answer-code and some values separated by `:` for each object in scope.
|
||
|
|
Several objects are separated by `;`.
|
||
|
|
|
||
|
|
### QSRU - Query Reflector Uptime
|
||
|
|
#### Reply
|
||
|
|
`ASRU;57234;`
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
Uptime of reflector in seconds
|
||
|
|
|
||
|
|
### QSRI - Query Reflector Info
|
||
|
|
#### Reply
|
||
|
|
`ASRI;62829:DE Germany:YSF262 BM263:pYSFReflector:20210326:1;`
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
ID:Name:Description:Software-Name:Version:Connections-Count
|
||
|
|
|
||
|
|
### QGWL - Query Gateway List
|
||
|
|
#### Reply
|
||
|
|
`AGWL;DL-LNK:161.97.73.43:57313;2622-DL:178.238.234.72:42000;DG9VH:84.58.124.6:42140;`
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
Callsign:IP-Address:Port
|
||
|
|
|
||
|
|
### QLHL - Query Last Heard List
|
||
|
|
#### Reply
|
||
|
|
`ALHL;DG9VH:DG9VH:ALL:724:29-03-2021 07-32-13:0;2622-DL:DN3VH:ALL:723:29-03-2021 07-31-52:0;`
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
Callsign:Gateway:Target:Position in List:Timestamp
|
||
|
|
|
||
|
|
### QREJ -
|
||
|
|
#### Reply
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
|
||
|
|
### QLHD -
|
||
|
|
#### Reply
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
|
||
|
|
### QRED -
|
||
|
|
#### Reply
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
|
||
|
|
### QACL - Query Access Control List-Statistics
|
||
|
|
#### Reply
|
||
|
|
`AACL;CS/0|AL/0|GW/0|IP/0;`
|
||
|
|
|
||
|
|
#### Description
|
||
|
|
CS/Number of muted Callsigns|AL/Number of whitelisted Callsigns|GW/Number of muted Gateways|IP/Number of muted IP-Adresses
|