ShaYmez/pYSFReflector
1
0
Fork 0
mirror of https://github.com/ShaYmez/pYSFReflector.git synced 2024-11-16 21:21:58 -05:00
Code Issues Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
Kim Huebel 2021-03-29 14:10:36 +01:00
parent 05a76168f0
commit c734531672
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
documentation/API.md
View File

@ -2,13 +2,13 @@
## Introduction ## Introduction
As many of us know YSFReflectors use the YSF protocol to communicate with endpoints. These original commands are well 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. 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 pYSFReflector has also an extended set of commands you can use for fetching information on the state of different things
when running the reflector. when running the reflector.
This document will show the commands and the replys expected from the reflector. This document will show the commands, and the replies expected from the reflector.
## How To Issue A Call ## 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: First 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` `echo -n "YSFS" | nc -u 127.0.0.1 42000 -w 2 && echo`
@ -16,12 +16,12 @@ or in a more general form:
`echo -n "<COMMAND>" | nc -u <IP-ADDRESS_OF_REFLECTOR> <PORT_OF_REFLECTOR> -w 2 && echo` `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. This line will send the chosen command to the reflector and prints out its reply.
## List Of Extended API-Commands ## List Of Extended API-Commands
Here we will not describe the standard-commands in the YSF protocol but the extended commandset by the pYSFReflector. Here we will not describe the standard-commands in the YSF protocol, but the extended command set by the pYSFReflector.
The format of the answer will be the corresponding answer-code and some values separated by `:` for each object in scope. 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 `;`. Several objects are separated by `;`.
### QSRU - Query Reflector Uptime ### QSRU - Query Reflector Uptime
@ -36,7 +36,7 @@ Uptime of reflector in seconds
`ASRI;62829:DE Germany:YSF262 BM263:pYSFReflector:20210326:1;` `ASRI;62829:DE Germany:YSF262 BM263:pYSFReflector:20210326:1;`
#### Description #### Description
ID:Name:Description:Software-Name:Version:Connections-Count ID:Name:Description:Software-Name:Version:Status of Regular Expression Check (can be -1/0/1)
### QGWL - Query Gateway List ### QGWL - Query Gateway List
#### Reply #### Reply
@ -50,21 +50,23 @@ Callsign:IP-Address:Port
`ALHL;DG9VH:DG9VH:ALL:724:29-03-2021 07-32-13:0;2622-DL:DN3VH:ALL:723:29-03-2021 07-31-52:0;` `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 #### Description
Callsign:Gateway:Target:Position in List:Timestamp Gateway:Callsign:Target:Timestamp:Position in List
### QREJ - ### QREJ - Query Rejected Callsigns/Gateways/IP-Addresses
#### Reply #### Reply
`AREJ;` `AREJ;DG9VH/CS:DG9VH400:ALL:-1:29-03-2021 12-17-08:-1;`
#### Description #### Description
### QLHD -
### QLHD - Query Last Heard List (with distinct callsigns)
#### Reply #### Reply
`ALHD;` `ALHD;2622-DL:DO7VN:ALL:2:29-03-2021 12-13-27:6;2622-DL:DH1VY:ALL:1:29-03-2021 11-45-30:0;`
#### Description #### Description
Gateway:Callsign:Target:Timestamp:Position in List
### QRED - ### QRED - Query Rejected Callsigns/Gateways/IP-Addresses (with distinct data)
#### Reply #### Reply
`ARED;` `ARED;`
@ -75,4 +77,4 @@ Callsign:Gateway:Target:Position in List:Timestamp
`AACL;CS/2|AL/1|GW/1|IP/0;CS:DN3VH;CS:DG9VH;AL:N0CALL;GW:DN3VH;` `AACL;CS/2|AL/1|GW/1|IP/0;CS:DN3VH;CS:DG9VH;AL:N0CALL;GW:DN3VH;`
#### Description #### Description
CS/Number of muted Callsigns|AL/Number of whitelisted Callsigns|GW/Number of muted Gateways|IP/Number of muted IP-Adresses;List of Entries from deny.db CS/Number of muted Callsigns|AL/Number of whitelisted Callsigns|GW/Number of muted Gateways|IP/Number of muted IP-Addresses;List of Entries from deny.db