Skip to content

Commit eac6175

Browse files
PaulZCPaulZC
committed
Adding the SparkX product ID. Adding .attenuateTXgain to the ARGOS 4 VLD examples.
1 parent 46ee9af commit eac6175

File tree

17 files changed

+76
-61
lines changed

17 files changed

+76
-61
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ SparkFun ARGOS ARTIC R2 Arduino Library
33

44
![SparkX ARTIC R2 Breakout]()
55

6-
[*SparkX ARTIC R2 Breakout*]()
6+
[*SparkX ARTIC R2 Breakout*](https://www.sparkfun.com/products/17236)
77

88
The ARTIC R2 chipset allows you to send and receive short data messages to and from anywhere via the ARGOS satellite network. Dedicated to programs which are related to environmental protection,
99
awareness or study, or to protecting human life, the ARGOS constellation provides full global coverage including the polar regions.

‎examples/Example10_TransmitARGOS3ZEWithPrediction/Example10_TransmitARGOS3ZEWithPrediction.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
1010
1111
Feel like supporting our work? Buy a board from SparkFun!
12-
https://www.sparkfun.com/products/
12+
https://www.sparkfun.com/products/17236
1313
https://www.sparkfun.com/products/15136
1414
https://www.sparkfun.com/products/15210
1515

‎examples/Example11_TransmitARGOS3WithPrediction/Example11_TransmitARGOS3WithPrediction.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
1010
1111
Feel like supporting our work? Buy a board from SparkFun!
12-
https://www.sparkfun.com/products/
12+
https://www.sparkfun.com/products/17236
1313
https://www.sparkfun.com/products/15136
1414
https://www.sparkfun.com/products/15210
1515

‎examples/Example12_TransmitARGOS2WithPrediction/Example12_TransmitARGOS2WithPrediction.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
1010
1111
Feel like supporting our work? Buy a board from SparkFun!
12-
https://www.sparkfun.com/products/
12+
https://www.sparkfun.com/products/17236
1313
https://www.sparkfun.com/products/15136
1414
https://www.sparkfun.com/products/15210
1515

‎examples/Example13_TransmitARGOS4VLDWithPrediction/Example13_TransmitARGOS4VLDWithPrediction.ino

+6-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
1010
1111
Feel like supporting our work? Buy a board from SparkFun!
12-
https://www.sparkfun.com/products/
12+
https://www.sparkfun.com/products/17236
1313
https://www.sparkfun.com/products/15136
1414
https://www.sparkfun.com/products/15210
1515
@@ -29,6 +29,8 @@
2929
repeats the message transmit numberTransmits times, repetitionPeriod seconds apart;
3030
repeats for the next satellite pass.
3131
32+
The transmit power can be reduced by 8dB by uncommenting the line: myARTIC.attenuateTXgain(true);
33+
3234
The messages are ARGOS 4 VLD (Long) and contain the GPS latitude and longitude in a compact form which ARGOS Web will understand.
3335
Please contact CLS / Woods Hole Group and ask them to apply the SPARKFUN_GPS template on ARGOS Web.
3436
The Latitude and Longitude will then be extracted, converted and displayed automatically when you view your data.
@@ -235,6 +237,9 @@ void loop()
235237
Serial.print(warmupTime);
236238
Serial.println(F(" seconds."));
237239

240+
// Uncomment the next line if you want to attenuate the transmit power by 8dB
241+
//myARTIC.attenuateTXgain(true);
242+
238243
loop_step = wait_for_GPS; // Move on
239244
}
240245
break;

‎examples/Example14_TransmitARGOS4VLDShortWithPrediction/Example14_TransmitARGOS4VLDShortWithPrediction.ino

+6-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
1010
1111
Feel like supporting our work? Buy a board from SparkFun!
12-
https://www.sparkfun.com/products/
12+
https://www.sparkfun.com/products/17236
1313
https://www.sparkfun.com/products/15136
1414
https://www.sparkfun.com/products/15210
1515
@@ -29,6 +29,8 @@
2929
repeats the message transmit numberTransmits times, repetitionPeriod seconds apart;
3030
repeats for the next satellite pass.
3131
32+
The transmit power can be reduced by 8dB by uncommenting the line: myARTIC.attenuateTXgain(true);
33+
3234
The ARGOS A4 VLD Short message contains only the 28-bit platform ID. Please change PLATFORM_ID below to your ID.
3335
3436
Please log in to ARGOS Web https://argos-system.cls.fr/argos-cwi2/login.html
@@ -237,6 +239,9 @@ void loop()
237239
; // Do nothing more
238240
}
239241

242+
// Uncomment the next line if you want to attenuate the transmit power by 8dB
243+
//myARTIC.attenuateTXgain(true);
244+
240245
loop_step = wait_for_GPS; // Move on
241246
}
242247
break;

‎examples/Example15_TransmitARGOS4VLDLongExample/Example15_TransmitARGOS4VLDLongExample.ino

+6-1
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@
1515
keeps checking the MCU status until transmit is complete;
1616
repeats.
1717
18+
The transmit power can be reduced by 8dB by uncommenting the line: myARTIC.attenuateTXgain(true);
19+
1820
The messages are ARGOS 4 VLD (Long) and contain the example used in A4-SS-TER-SP-0079-CNES.
1921
2022
License: please see the license file at:
2123
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
2224
2325
Feel like supporting our work? Buy a board from SparkFun!
24-
https://www.sparkfun.com/products/
26+
https://www.sparkfun.com/products/17236
2527
2628
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2729
@@ -149,6 +151,9 @@ void loop()
149151
Serial.print(tx4freq, 3);
150152
Serial.println(F(" MHz."));
151153

154+
// Uncomment the next line if you want to attenuate the transmit power by 8dB
155+
//myARTIC.attenuateTXgain(true);
156+
152157
loop_step = ARTIC_TX; // Move on
153158
}
154159
break;

‎examples/Example16_TransmitARGOS3ZEExample/Example16_TransmitARGOS3ZEExample.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
2222
2323
Feel like supporting our work? Buy a board from SparkFun!
24-
https://www.sparkfun.com/products/
24+
https://www.sparkfun.com/products/17236
2525
2626
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2727

‎examples/Example1_FirmwareVersion/Example1_FirmwareVersion.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
1616
1717
Feel like supporting our work? Buy a board from SparkFun!
18-
https://www.sparkfun.com/products/
18+
https://www.sparkfun.com/products/17236
1919
2020
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2121

‎examples/Example2_FirmwareStatus/Example2_FirmwareStatus.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
1616
1717
Feel like supporting our work? Buy a board from SparkFun!
18-
https://www.sparkfun.com/products/
18+
https://www.sparkfun.com/products/17236
1919
2020
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2121

‎examples/Example3_ReadSettings/Example3_ReadSettings.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
1111
1212
Feel like supporting our work? Buy a board from SparkFun!
13-
https://www.sparkfun.com/products/
13+
https://www.sparkfun.com/products/17236
1414
1515
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
1616

‎examples/Example4_SatelliteDetection/Example4_SatelliteDetection.ino

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
1717
1818
Feel like supporting our work? Buy a board from SparkFun!
19-
https://www.sparkfun.com/products/
19+
https://www.sparkfun.com/products/17236
2020
2121
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2222
@@ -79,16 +79,16 @@ void setup()
7979

8080
// Read and print the ARTIC R2 firmware status
8181
ARTIC_R2_Firmware_Status status;
82-
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
82+
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
8383
Serial.println(F("ARTIC R2 Firmware Status:"));
8484
myARTIC.printFirmwareStatus(status); // Pretty-print the firmware status to Serial
8585
Serial.println();
86-
86+
8787
// Read and print the ARGOS configuration
8888
ARGOS_Configuration_Register configuration;
8989
myARTIC.readARGOSconfiguration(&configuration);
9090
myARTIC.printARGOSconfiguration(configuration); // Pretty-print the TX and RX configuration to Serial
91-
91+
9292
// Set the satellite detection timeout to 600 seconds
9393
if (myARTIC.setSatelliteDetectionTimeout(600) == false)
9494
{
@@ -122,7 +122,7 @@ void setup()
122122
Serial.println(F("ARTIC R2 MCU instruction result:"));
123123
myARTIC.printCommandResult(result); // Pretty-print the command result to Serial
124124
Serial.println();
125-
125+
126126
if ((result == ARTIC_R2_MCU_COMMAND_REJECTED) || (result == ARTIC_R2_MCU_COMMAND_OVERFLOW))
127127
{
128128
Serial.println("MCU Command failed! Freezing...");

‎examples/Example5_ReceiveOneMessage/Example5_ReceiveOneMessage.ino

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
1818
1919
Feel like supporting our work? Buy a board from SparkFun!
20-
https://www.sparkfun.com/products/
20+
https://www.sparkfun.com/products/17236
2121
2222
The ARTIC firmware takes up 127KB of program memory! Please choose a processor with memory to spare.
2323
@@ -80,18 +80,18 @@ void setup()
8080

8181
// Read and print the ARTIC R2 status register
8282
ARTIC_R2_Firmware_Status status;
83-
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
83+
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
8484
Serial.println(F("ARTIC R2 Firmware Status:"));
8585
myARTIC.printFirmwareStatus(status); // Pretty-print the firmware status to Serial
8686
Serial.println();
87-
87+
8888
// Read and print the ARGOS configuration
8989
ARGOS_Configuration_Register configuration;
9090
myARTIC.readARGOSconfiguration(&configuration);
9191
myARTIC.printARGOSconfiguration(configuration); // Pretty-print the TX and RX configuration to Serial
9292

9393
Serial.println(F("Setting the RX mode to ARGOS 3..."));
94-
94+
9595
// Set the RX mode to ARGOS 3
9696
ARTIC_R2_MCU_Command_Result result = myARTIC.sendConfigurationCommand(CONFIG_CMD_SET_ARGOS_3_RX_MODE);
9797
myARTIC.printCommandResult(result); // Pretty-print the command result to Serial
@@ -121,15 +121,15 @@ void setup()
121121
// Start the ARTIC in receiving mode for an unlimited time until 1 message has been received.
122122
// If the message is received the Artic will go to IDLE. The user can abort the reception using the ‘Go to idle’ command.
123123
result = myARTIC.sendMCUinstruction(INST_START_RECEIVING_1_MESSAGE);
124-
124+
125125
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
126126
Serial.println(F("ARTIC R2 Firmware Status:"));
127127
myARTIC.printFirmwareStatus(status); // Pretty-print the firmware status to Serial
128128
Serial.println();
129129
Serial.println(F("ARTIC R2 MCU instruction result:"));
130130
myARTIC.printCommandResult(result); // Pretty-print the command result to Serial
131131
Serial.println();
132-
132+
133133
if ((result == ARTIC_R2_MCU_COMMAND_REJECTED) || (result == ARTIC_R2_MCU_COMMAND_OVERFLOW))
134134
{
135135
Serial.println("MCU Command failed! Freezing...");
@@ -169,7 +169,7 @@ void loop()
169169
Serial.println();
170170
Serial.println(F("Message reception is complete!"));
171171
Serial.println();
172-
172+
173173
if (progress == ARTIC_R2_MCU_PROGRESS_RECEIVE_ONE_MESSAGE_RX_VALID_MESSAGE) // If a message was received, read it.
174174
{
175175
// Read a downlink message from the RX payload buffer
@@ -194,7 +194,7 @@ void loop()
194194
Serial.println(F("readDownlinkMessage failed!"));
195195
}
196196
}
197-
197+
198198
Serial.println();
199199
Serial.println(F("We are done. Freezing..."));
200200
while (1)

‎examples/Example6_ReceiveOneMessageWithFiltering/Example6_ReceiveOneMessageWithFiltering.ino

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
https://github.com/sparkfun/SparkFun_ARGOS_ARTIC_R2_Arduino_Library/LICENSE.md
2020
2121
Feel like supporting our work? Buy a board from SparkFun!
22-
https://www.sparkfun.com/products/
22+
https://www.sparkfun.com/products/17236
2323
2424
This example requires a Platform ID. Copy and paste your 28-bit Platform ID into ADDRESS_LS_BITS and ADDRESS_MS_BITS. (See below)
2525
@@ -88,18 +88,18 @@ void setup()
8888

8989
// Read and print the ARTIC R2 status register
9090
ARTIC_R2_Firmware_Status status;
91-
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
91+
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
9292
Serial.println(F("ARTIC R2 Firmware Status:"));
9393
myARTIC.printFirmwareStatus(status); // Pretty-print the firmware status to Serial
9494
Serial.println();
95-
95+
9696
// Read and print the ARGOS configuration
9797
ARGOS_Configuration_Register configuration;
9898
myARTIC.readARGOSconfiguration(&configuration);
9999
myARTIC.printARGOSconfiguration(configuration); // Pretty-print the TX and RX configuration to Serial
100100

101101
Serial.println(F("Setting the RX mode to ARGOS 3..."));
102-
102+
103103
// Set the RX mode to ARGOS 3
104104
ARTIC_R2_MCU_Command_Result result = myARTIC.sendConfigurationCommand(CONFIG_CMD_SET_ARGOS_3_RX_MODE);
105105
myARTIC.printCommandResult(result); // Pretty-print the command result to Serial
@@ -168,14 +168,14 @@ void setup()
168168
// Start the ARTIC in receiving mode for an unlimited time until 1 message has been received.
169169
// If the message is received the Artic will go to IDLE. The user can abort the reception using the ‘Go to idle’ command.
170170
result = myARTIC.sendMCUinstruction(INST_START_RECEIVING_1_MESSAGE);
171-
171+
172172
myARTIC.readStatusRegister(&status); // Read the ARTIC R2 status register
173173
Serial.println(F("ARTIC R2 Firmware Status:"));
174174
myARTIC.printFirmwareStatus(status); // Pretty-print the firmware status to Serial
175175
Serial.println();
176176
Serial.println(F("ARTIC R2 MCU instruction result:"));
177177
myARTIC.printCommandResult(result); // Pretty-print the command result to Serial
178-
178+
179179
if ((result == ARTIC_R2_MCU_COMMAND_REJECTED) || (result == ARTIC_R2_MCU_COMMAND_OVERFLOW))
180180
{
181181
Serial.println("MCU Command failed! Freezing...");
@@ -215,7 +215,7 @@ void loop()
215215
Serial.println();
216216
Serial.println(F("Message reception is complete!"));
217217
Serial.println();
218-
218+
219219
if (progress == ARTIC_R2_MCU_PROGRESS_RECEIVE_ONE_MESSAGE_RX_VALID_MESSAGE) // If a message was received, read it.
220220
{
221221
// Read a downlink message from the RX payload buffer
@@ -240,7 +240,7 @@ void loop()
240240
Serial.println(F("readDownlinkMessage failed!"));
241241
}
242242
}
243-
243+
244244
Serial.println();
245245
Serial.println(F("We are done. Freezing..."));
246246
while (1)

0 commit comments

Comments
 (0)
close