FreeDATA/documentation/FreeDATA-daemon_network_documentation.md

181 lines
2.8 KiB
Markdown
Raw Normal View History

2023-02-11 21:49:07 +00:00
# FreeDATA - DAEMON network documentation
## GET DAEMON STATE
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Get the current daemon state
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: GET
- Command: DAEMON_STATE
- Parameter: --- (str)
2023-02-11 21:49:07 +00:00
#### Example
```
{"type" : "GET", "command" : "DAEMON_STATE"}
```
#### Returns
2023-02-11 21:49:07 +00:00
```
{
"COMMAND": "DAEMON_STATE",
"DAEMON_STATE": [],
"PYTHON_VERSION": str(python_version),
"HAMLIB_VERSION": str(hamlib_version),
"INPUT_DEVICES": [],
"OUTPUT_DEVICES": [],
2023-02-11 21:49:07 +00:00
"SERIAL_DEVICES": [],
"CPU": "",
"RAM": "",
"VERSION": "0.1-prototype"
}
```
## SET CALLSIGN
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Save your callsign to the daemon
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: SET
- Command: MYCALLSIGN
- Parameter: callsign (str)
- timestamp: unix timestamp (str)
2023-02-11 21:49:07 +00:00
#### Example
```
{"type" : "SET", "command": "MYCALLSIGN" , "parameter": "<callsign>", "timestamp" : "123456789"}
```
## SET GRIDSQUARE
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Save your gridsquare/maidenhead-locator to the daemon
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: SET
- Command: MYGRID
- Parameter: gridsquare (str)
- timestamp: unix timestamp (str)
2023-02-11 21:49:07 +00:00
#### Example
```
{"type" : "SET", "command": "MYGRID" , "parameter": "<gridsquare>", "timestamp" : "123456789"}
```
## TEST HAMLIB
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Test your hamlib settings
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: GET
- Command: TEST_HAMLIB
- Parameter: obj
2023-02-11 21:49:07 +00:00
- devicename
- deviceport
- pttprotocol
- pttport
- serialspeed
- data_bits
- stop_bits
- handshake
- timestamp: unix timestamp (str)
2023-02-11 21:49:07 +00:00
#### Example
```
{
"type": "GET",
"command" : "TEST_HAMLIB",
"parameter" : [{
"devicename" : "<devicename>",
"deviceport" : "<deviceport>",
"pttprotocol" : "<pttprotocol>",
"pttport" : "<pttport>",
"serialspeed" : "<serialspeed>",
"data_bits" : "<data_bits>",
"stop_bits" : "<stop_bits>",
"handshake" : "<handshake>"
}]
}
```
## START TNC
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Start the tnc process
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: GET
- Command: TEST_HAMLIB
- Parameter: obj
2023-02-11 21:49:07 +00:00
- mycall
- mygrid
- rx_audio
- tx_audio
- devicename
- deviceport
- pttprotocol
- pttport
- serialspeed
- data_bits
- stop_bits
- handshake
#### Example
```
{
type: 'SET',
command: 'STARTTNC',
parameter: [{
mycall: mycall,
mygrid: mygrid,
rx_audio: rx_audio,
tx_audio: tx_audio,
devicename: devicename,
deviceport: deviceport,
pttprotocol: pttprotocol,
pttport: pttport,
serialspeed: serialspeed,
data_bits: data_bits,
stop_bits: stop_bits,
handshake: handshake
}]
}
```
## STOP TNC
2023-02-11 21:49:07 +00:00
#### Description:
2023-02-11 21:49:07 +00:00
Stop the tnc process
#### Parameters
2023-02-11 21:49:07 +00:00
- Type: SET
- Command: STOPTNC
- Parameter: ---
2023-02-11 21:49:07 +00:00
#### Example
```
{"type" : "SET", "command": "STOPTNC" , "parameter": "---" }
```