Zachtek API

Contents:
  1. Notes
  2. 1. API - PC User config Set or Get commands
  3. 2. API - PC Factory config Set or Get commands
  4. 3. API - Arduino replies to Get commands
  5. 4. API - Arduino Status update messages
  6. 5. API - Band Numbers

[Top][Home]

Notes



[Top][Home]

EEPROM The configuration has an active configuration in RAM and a saved version in EEPROM. The command [CSE] S will store the RAM version to EEPROM. At boot the data in EEPROM is transferred to RAM. The data is divided in two sections. Factory data and User data. The factory data can not be changed by configuration software and holds information about the hardware, e.g what low pass filters are fitted in the four filter banks, what the measured value of the TCXO reference was at last calibration etc.

Run Mode To change the device to run mode set DTR LOW and wait a while (100ms) until data starts to flow

Reset To reset the device, set RTS to HIGH and wait a while (100ms) then set RTS to LOW.



[Top][Home]

1. API - PC User config Set or Get commands

Description Send Set/GetData [8..]Comment
Command CurrentMode [CCM]S/GText 1 S=Sig, W=WSPR, N=None (Idle)
Command CurrentReference [CCR]G Text 1 E=External, I=Internal
Command User Config Store in EEPROM[CSE]S
Option TX Pause [OTP]S/GText 5 0-99999 Minutes
Option StartMode [OSM]S/GText 1 S=Sig, W=WSPR, N=None
Option Band TX Enable [OBD]S/GText 2 Text 1 - Band number 1-API-User-Config.tab 2-API-PC-Factory-config-Set-or-Get-Commands.tab 3-API-Arduino-replies-to-Get.tab 4-API-Arduino-Status-update-msg.tab 5-API-Band-Numbers.tab , E/D E=Enable, D=Disable
Option Location [OLC]S/GText 1. G=GPS calculated, M=Manual (DL4 or DL6 data)
Option Locator Precision [OLP]S/GText 1. 4 or 6 = Number of character used in the Maidenhead report.
Option Power [OPW]S/GText 1. N=Normal using the DPD Power Data. A=Altitude encoded.
Option Time Slot [OTS]S/GText 2 Time Slot Code 0 to 16.
0-4=10 min. schedule
5-14=20min schedule
15=Band coordinated schedule
16=No schedule
17=Tracker (only TX when on the move or at top of hour)
Option PreFix/Suffix [OPS]S/G
Optionion set GPS Constellations [OSC]S/G
Data CallSign [DCS]S/G
Data Suffix [DSF]S/GText 3 Suffix code
000-125
000-009= 0 to 9
010-035=A to Z
Call Sign suffix code. A / will be automatically appended after the Call Sign followed by the suffix
Data Prefix [DPF]S/GText 3 Prefix padded with leading spaces if less than three characters. A-Z and 0-9 allowed Call Sign prefix chars. A / will be automatically added between the Prefix and the Call Sign
Data Locator 4 [DL4]S/GText 4 Maidenhead grid with four characters
Data Locator 6 [DL6]S/GText 6 Maidenhead grid with six characters
Data PowerData [DPD]S/GText 2 Power in dBm. Padded with a leading zero to two characters 0-60dBm
Data Name [DNM]S/GText 40
Data Generator Frequency [DGF]S/GText 12 Frequency in Centi Hertz. Padded with leading zeros to 12 characters
Debug Set LP Filter [CSL]SText 1. Text1=A,B,C or D for LP bank.LP filters are automatically set by the WSPR Beacon and Signal Gen. routines but can be temporarily overridden by this command for testing purposes
Data External Reference Frequencys [DER]S/GText 9 Frequency in Hertz. Padded with leading zeros to 9 charactersNormally 010000000


[Top][Home]

2. API - PC Factory config Set or Get commands

Description Send Set/GetData [8..]Comment
Command CurrentMode [CCM]S/GText 1 S=Sig, W=WSPR, N=None (Idle)
Command CurrentReference [CCR]G Text 1 E=External, I=Internal
Command User Config Store in EEPROM[CSE]S
Option TX Pause [OTP]S/GText 5 0-99999 Minutes
Option StartMode [OSM]S/GText 1 S=Sig, W=WSPR, N=None
Option Band TX Enable [OBD]S/GText 2 Text 1 - Band number 1-API-User-Config.tab 2-API-PC-Factory-config-Set-or-Get-Commands.tab 3-API-Arduino-replies-to-Get.tab 4-API-Arduino-Status-update-msg.tab 5-API-Band-Numbers.tab , E/D E=Enable, D=Disable
Option Location [OLC]S/GText 1. G=GPS calculated, M=Manual (DL4 or DL6 data)
Option Locator Precision [OLP]S/GText 1. 4 or 6 = Number of character used in the Maidenhead report.
Option Power [OPW]S/GText 1. N=Normal using the DPD Power Data. A=Altitude encoded.
Option Time Slot [OTS]S/GText 2 Time Slot Code 0 to 16.
0-4=10 min. schedule
5-14=20min schedule
15=Band coordinated schedule
16=No schedule
17=Tracker (only TX when on the move or at top of hour)
Option PreFix/Suffix [OPS]S/G
Optionion set GPS Constellations [OSC]S/G
Data CallSign [DCS]S/G
Data Suffix [DSF]S/GText 3 Suffix code
000-125
000-009= 0 to 9
010-035=A to Z
Call Sign suffix code. A / will be automatically appended after the Call Sign followed by the suffix
Data Prefix [DPF]S/GText 3 Prefix padded with leading spaces if less than three characters. A-Z and 0-9 allowed Call Sign prefix chars. A / will be automatically added between the Prefix and the Call Sign
Data Locator 4 [DL4]S/GText 4 Maidenhead grid with four characters
Data Locator 6 [DL6]S/GText 6 Maidenhead grid with six characters
Data PowerData [DPD]S/GText 2 Power in dBm. Padded with a leading zero to two characters 0-60dBm
Data Name [DNM]S/GText 40
Data Generator Frequency [DGF]S/GText 12 Frequency in Centi Hertz. Padded with leading zeros to 12 characters
Debug Set LP Filter [CSL]SText 1. Text1=A,B,C or D for LP bank.LP filters are automatically set by the WSPR Beacon and Signal Gen. routines but can be temporarily overridden by this command for testing purposes
Data External Reference Frequencys [DER]S/GText 9 Frequency in Hertz. Padded with leading zeros to 9 charactersNormally 010000000


[Top][Home]

3. API - Arduino replies to Get commands

Description ReturnType of data and number of bytes
Cmd CurrentMode {CCM}Text 1 S=Sig, W=WSPR, N=None
Option TX Pause {OTP}Text 5 0-99999 Minutes
Option StartMode {OSM}Text 1 S=Sig, W=WSPR, N=None
Option Band TX Enable {OBD}Text 2 Text 1. Band number *, E=Enable, D=Disable
Option Location {OLC}Text 1. G=GPS calculated, M=Manual (DL4 data)
Optionion set GPS Constellations{OSC}Text 1. G=GPS Only B=BeiDou Only, A= GPS And BeiDou
Dat CallSign {DCS}Text 6
Dat Locator 4 {DL4}Text 4
Dat Locator 6 {DL6}Text 6
Dat PowerData {DPD}Text 2 (00 to 60) dBm
Dat Name {DNM}Text 40
Dat Generator Freq {DGF}Text 12 Frequency in Centi Hertz. Padded with leading zeros to 12 characters


[Top][Home]

4. API - Arduino Status update messages

These messages are sent whenever the device thinks it's appropriate

Description ReturnType of data and number of bytes
Current Mode {CCM} Text 1 S=Sig, W=WSPR, N=None
GPS locator 4 char Maidenhead {GL4} Text 4
GPS Locator 6 char Maidenhead {GL6} Test 6
GPS Time {GTM} Text 8 HH:MM:SS
GPS Lock {GLC} Text 1 T=True F=False
GPS Satellite data {GSI} Text2 Text3 Text2 Text2 - ID Az El SNR
Transmitter Frequency {TFQ} Text 5-12 Frequency in centiHz, no leading zeros
Transmitter On {TON} Text 1 T=True F=False
Microcontroller Pause {MPS} Text 7 0-4,000,000Seconds
Microcontroller Information {MIN} Text
Low Pass filter set {LPI} Text 1 A-D
MicroController VCC Voltage {MVC} Text 4 0-9999mV (Normally 3300)
Transmitter WSPR Symnol {TBN} Text 2=Band number 1-API-User-Config.tab 2-API-PC-Factory-config-Set-or-Get-Commands.tab 3-API-Arduino-replies-to-Get.tab 4-API-Arduino-Status-update-msg.tab 5-API-Band-Numbers.tab
Transmitter WSPR Symbol {TWS} Text 2 Text3 Band number *, WSPR symbol count 0-161
Transmitter WSPR Band Cycle Complete{TCC}


[Top][Home]

5. API - Band Numbers

NoBand
002190m
01630m
02160m
0380m
0440m
0530m
0620m
0717m
815m
912m
1010m
116m
124m
132m
1470cm
1523cm


[Top][Home]
Glenn Lyons VK4PK
glenn@LyonsComputer.com.au
Ver:gnl20240213 - pre published v0.9