From c73453167277c233ebbab4679f6576ba3e8af4b0 Mon Sep 17 00:00:00 2001 From: Kim Huebel Date: Mon, 29 Mar 2021 14:10:36 +0100 Subject: [PATCH] Updates --- documentation/API.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/documentation/API.md b/documentation/API.md index f72d826..67546ff 100644 --- a/documentation/API.md +++ b/documentation/API.md @@ -2,13 +2,13 @@ ## 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 +pYSFReflector has also an extended set of commands you can use for fetching information on the state of different things 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 -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` @@ -16,12 +16,12 @@ or in a more general form: `echo -n "" | nc -u -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 -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 `;`. ### QSRU - Query Reflector Uptime @@ -36,7 +36,7 @@ Uptime of reflector in seconds `ASRI;62829:DE Germany:YSF262 BM263:pYSFReflector:20210326:1;` #### 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 #### 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;` #### Description -Callsign:Gateway:Target:Position in List:Timestamp +Gateway:Callsign:Target:Timestamp:Position in List -### QREJ - +### QREJ - Query Rejected Callsigns/Gateways/IP-Addresses #### Reply -`AREJ;` +`AREJ;DG9VH/CS:DG9VH400:ALL:-1:29-03-2021 12-17-08:-1;` #### Description -### QLHD - + +### QLHD - Query Last Heard List (with distinct callsigns) #### 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 +Gateway:Callsign:Target:Timestamp:Position in List -### QRED - +### QRED - Query Rejected Callsigns/Gateways/IP-Addresses (with distinct data) #### Reply `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;` #### 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