Skip to content

Update README #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 27, 2023
Merged

Update README #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
509a45f
Merge branch 'main' into release_candidate
PaulZC Feb 18, 2023
8224fff
Update README.md
PaulZC Feb 27, 2023
323cea6
Update README.md
PaulZC Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions COMPILE_BINARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Click the File icon to the right of the `Additional Boards Manager URLs` text bo
Add:

```
https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/master/package_sparkfun_apollo3_index.json
https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/main/package_sparkfun_apollo3_index.json
```

Click OK
Expand Down Expand Up @@ -90,7 +90,9 @@ Copy the entire `OpenLog_Artemis` folder from the Zip file into your `Arduino` f
C:\Users\<Your_User>\Documents\Arduino\OpenLog_Artemis
```

## Copy Paulvha's Patch for Apollo3
## Patch the Apollo3 Core

The Apollo3 core (2.2.1) requires patching - using code kindly provided by Paulvha. For more information, open [this link](https://github.com/sparkfun/OpenLog_Artemis/issues/117#issuecomment-1085881142) in a web browser.

Navigate to the `Extras` folder in the Zip file. Copy the `UartPower3.zip` file. Paste it into the Apollo3 board package folder. On Windows machines, this is (usually):

Expand All @@ -100,15 +102,11 @@ C:\Users\<Your_User>\AppData\Local\Arduino15\packages\SparkFun\hardware\apollo3

Unzip it (Extract All files)

## Update the Apollo3 Core

**Close the Arduino IDE**

For information, open this link in a web browser: https://github.com/sparkfun/OpenLog_Artemis/issues/117#issuecomment-1085881142

Follow Paul's instructions contained in `uart_power_3.odt`
Follow the instructions contained in `uart_power_3.odt`

Summary: replace the following five files with the ones from `UartPower3.zip` :
In summary: replace the following five files with the ones from `UartPower3.zip` :

```
C:\Users\<Your_User>\AppData\Local\Arduino15\packages\SparkFun\hardware\apollo3\2.2.1\cores\arduino\mbed-bridge\core-extend\HardwareSerial.h
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ Documentation
* **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library.
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - OLA includes a large number of libraries that will need to be installed before compiling will work.
* **[ADDING_SENSORS.md](./ADDING_SENSORS.md)** - contains _abbreviated_ instructions on how to add a new sensor to the OLA firmware. It's more of an aide-memoire really... Sorry about that.
* **[COMPILE_BINARY.md](./COMPILE_BINARY)** - contains _abbreviated_ instructions on how to compile the OLA firmware binary manually. It's also an aide-memoire really... Sorry about that.
* **[SENSOR_UNITS.md](./SENSOR_UNITS.md)** - contains a summary of the units used for each sensor measurement.

Product Versions
Expand Down