Skip to content

Commit e5b83ed

Browse files
committed
Update README.md for JT4
1 parent 544b4f8 commit e5b83ed

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
JT65/JT9/WSPR Encoder Library for Arduino
2-
=========================================
3-
This library very simply generates a set of channel symbols for JT65, JT9, or WSPR based on the user providing a properly formatted Type 6 message for JT65 or JT9 (which is 13 valid characters) or a callsign, Maidenhead grid locator, and power output for WSPR. When paired with a synthesizer that can output frequencies in fine, phase-continuous tuning steps (such as the Si5351), then a beacon or telemetry transmitter can be created which can change the transmitted characters as needed from the Arduino.
1+
JT65/JT9/JT4/WSPR Encoder Library for Arduino
2+
=============================================
3+
This library very simply generates a set of channel symbols for JT65, JT9, JT4, or WSPR based on the user providing a properly formatted Type 6 message for JT65, JT9, or JT4 (which is 13 valid characters) or a callsign, Maidenhead grid locator, and power output for WSPR. When paired with a synthesizer that can output frequencies in fine, phase-continuous tuning steps (such as the Si5351), then a beacon or telemetry transmitter can be created which can change the transmitted characters as needed from the Arduino.
44

55
Please feel free to use the issues feature of GitHub if you run into problems or have suggestions for important features to implement.
66

@@ -16,11 +16,11 @@ Include the JTEncode library into your instance of the Arduino IDE. Download a Z
1616

1717
Example
1818
-------
19-
There is a simple example that is placed in your examples menu under JTEncode. Open this to see how to incorporate this library with your code. The example provided with with the library is meant to be used in conjuction with the [Etherkit Si5351A Breakout Board](https://www.etherkit.com/rf-modules/si5351a-breakout-board.html), although it could be modified to use with other synthesizers which meet the technical requirements of the JT65/JT9/WSPR modes.
19+
There is a simple example that is placed in your examples menu under JTEncode. Open this to see how to incorporate this library with your code. The example provided with with the library is meant to be used in conjuction with the [Etherkit Si5351A Breakout Board](https://www.etherkit.com/rf-modules/si5351a-breakout-board.html), although it could be modified to use with other synthesizers which meet the technical requirements of the JT65/JT9/JT4/WSPR modes.
2020

2121
To run this example, be sure to download the [Si5351Arduino](https://github.com/etherkit/Si5351Arduino) library and follow the instructions there to connect the Si5351A Breakout Board to your Arduino. In order to trigger transmissions, you will also need to connect a momentary pushbutton from pin 12 of the Arduino to ground.
2222

23-
The example sketch itself is fairly straightforward. JT65, JT9, and WSPR modes are modulated in same way: phase-continuous multiple-frequency shift keying (MFSK). The message to be transmitted is passed to the JTEncode method corresponding to the desired mode, along with a pointer to an array which holds the returned channel symbols. When the pushbutton is pushed, the sketch then transmits each channel symbol sequentially as an offset from the base frequency given in the sketch define section.
23+
The example sketch itself is fairly straightforward. JT65, JT9, JT4, and WSPR modes are modulated in same way: phase-continuous multiple-frequency shift keying (MFSK). The message to be transmitted is passed to the JTEncode method corresponding to the desired mode, along with a pointer to an array which holds the returned channel symbols. When the pushbutton is pushed, the sketch then transmits each channel symbol sequentially as an offset from the base frequency given in the sketch define section.
2424

2525
An instance of the JTEncode object is created:
2626

@@ -44,6 +44,12 @@ On sketch startup, the mode parameters are set based on which mode is currently
4444
symbol_count = JT65_SYMBOL_COUNT; // From the library defines
4545
tone_spacing = JT65_TONE_SPACING;
4646
break;
47+
case MODE_JT4:
48+
freq = JT4_DEFAULT_FREQ;
49+
ctc = JT4_CTC;
50+
symbol_count = JT4_SYMBOL_COUNT; // From the library defines
51+
tone_spacing = JT4_TONE_SPACING;
52+
break;
4753
case MODE_WSPR:
4854
freq = WSPR_DEFAULT_FREQ;
4955
ctc = WSPR_CTC;
@@ -65,6 +71,9 @@ During transmit, the proper class method is chosen based on the desired mode, th
6571
case MODE_JT65:
6672
jtencode.jt65_encode(message, tx_buffer);
6773
break;
74+
case MODE_JT4:
75+
jtencode.jt4_encode(message, tx_buffer);
76+
break;
6877
case MODE_WSPR:
6978
jtencode.wspr_encode(call, loc, dbm, tx_buffer);
7079
break;
@@ -111,6 +120,21 @@ Public Methods
111120
*/
112121
```
113122

123+
###jt4_encode()
124+
```
125+
/*
126+
* jt4_encode(char * message, uint8_t * symbols)
127+
*
128+
* Takes an arbitrary message of up to 13 allowable characters and returns
129+
* a channel symbol table.
130+
*
131+
* message - Plaintext Type 6 message.
132+
* symbols - Array of channel symbols to transmit retunred by the method.
133+
* Ensure that you pass a uint8_t array of size JT4_SYMBOL_COUNT to the method.
134+
*
135+
*/
136+
```
137+
114138
###wspr_encode()
115139
```
116140
/*

0 commit comments

Comments
 (0)