Fix #340: rename extras directory

mcci-catena · Jun 14, 2022 · d300113 · d300113
1 parent 7054ded
commit d300113
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -9,98 +9,98 @@ _Apologies_: This document is a work in progress, and is published in this inter
 <!-- markdownlint-disable MD033 -->
 <!-- markdownlint-capture -->
 <!-- markdownlint-disable -->
-<!-- TOC depthFrom:2 updateOnSave:true -->
+<!-- TOC depthfrom:2 updateonsave:true -->
 
 - [Overview](#overview)
 - [Coding Practices](#coding-practices)
 - [Standard Application Framework Initialization](#standard-application-framework-initialization)
 - [Components](#components)
-        - [Namespace `McciCatena`](#namespace-mccicatena)
-        - [Class `Catena` and header file `Catena.h`](#class-catena-and-header-file-catenah)
-        - [Board-specific Classes](#board-specific-classes)
-        - [Class derivation](#class-derivation)
-                - [STM32 Classes](#stm32-classes)
-                - [SAMD Classes](#samd-classes)
-        - [Platform Management](#platform-management)
-                - [Platform GUIDs](#platform-guids)
-                - [GUIDs for the Catena 461x family](#guids-for-the-catena-461x-family)
-                        - [Catena 4610](#catena-4610)
-                        - [Catena 4612](#catena-4612)
-                        - [Catena 4618](#catena-4618)
-                        - [Catena 4630](#catena-4630)
-                - [GUIDs for the Catena 4450/4460/4470 family](#guids-for-the-catena-445044604470-family)
-                        - [Catena 4450](#catena-4450)
-                        - [Catena 4460](#catena-4460)
-                        - [Catena 4470](#catena-4470)
-                - [GUIDs for the Catena 480x family](#guids-for-the-catena-480x-family)
-                        - [Catena 4801](#catena-4801)
-                        - [Catena 4802](#catena-4802)
-                - [GUIDs for Adafruit Feather M0s](#guids-for-adafruit-feather-m0s)
-        - [Polling Framework](#polling-framework)
-                - [Making a class pollable](#making-a-class-pollable)
-                - [Using pollable objects in sketches](#using-pollable-objects-in-sketches)
-        - [Finite State Machine (FSM) Framework](#finite-state-machine-fsm-framework)
-                - [Getting ready](#getting-ready)
-                - [Defining the state `enum class`](#defining-the-state-enum-class)
-                - [Identify the parent class](#identify-the-parent-class)
-                - [Add the state type to the parent class](#add-the-state-type-to-the-parent-class)
-                - [Define the FSM instance in the parent class](#define-the-fsm-instance-in-the-parent-class)
-                - [Declare a method function in the parent class](#declare-a-method-function-in-the-parent-class)
-                - [Implement the FSM dispatch function](#implement-the-fsm-dispatch-function)
-                - [Implement the FSM initialization](#implement-the-fsm-initialization)
-        - [The general time/date class `McciCatena::cDate`](#the-general-timedate-class-mccicatenacdate)
-                - [Interval Seconds](#interval-seconds)
-                - [`cDate` calendar types](#cdate-calendar-types)
-                - [`cDate` properties](#cdate-properties)
-                - [`cDate` methods](#cdate-methods)
-                - [Timekeeping, solar days, leap seconds](#timekeeping-solar-days-leap-seconds)
-        - [LoRaWAN Support](#lorawan-support)
-                - [Sending an uplink message](#sending-an-uplink-message)
-                - [Registering to receive downlink messages](#registering-to-receive-downlink-messages)
-                - [LoRaWAN Class Structure](#lorawan-class-structure)
-        - [FRAM Storage Management](#fram-storage-management)
-                - [FRAM Storage Formats](#fram-storage-formats)
-                        - [Object Storage Structure](#object-storage-structure)
-                        - [Bit layout of `uSizeKey`](#bit-layout-of-usizekey)
-                        - [The FRAM header object](#the-fram-header-object)
-                - [Adding FRAM objects](#adding-fram-objects)
-                - [Class hierarchy within the FRAM library](#class-hierarchy-within-the-fram-library)
-        - [Asynchronous Serial Port Command Processing](#asynchronous-serial-port-command-processing)
-                - [Collecting lines asynchronously from streams](#collecting-lines-asynchronously-from-streams)
-                - [The command parser](#the-command-parser)
-                - [Command stream methods for use by functions](#command-stream-methods-for-use-by-functions)
-                - [Synchronous Command Functions](#synchronous-command-functions)
-                - [Asynchronous Command Functions](#asynchronous-command-functions)
-        - [Clock Management and Calibration](#clock-management-and-calibration)
-        - [Si1133 driver](#si1133-driver)
-        - [`cTimer` Timer object](#ctimer-timer-object)
-                - [Catena_Timer.h header file and initialization](#catena_timerh-header-file-and-initialization)
-                - [cTimer begin() and end()](#ctimer-begin-and-end)
-                - [Checking for `cTimer` events](#checking-for-ctimer-events)
-                - [`cTimer` Utility routines](#ctimer-utility-routines)
-        - [`Catena_functional.h`](#catena_functionalh)
-        - [`cDownload`](#cdownload)
-        - [`cBootloaderApi`](#cbootloaderapi)
-        - [`cSerial`](#cserial)
+   - [Namespace McciCatena](#namespace-mccicatena)
+   - [Class Catena and header file Catena.h](#class-catena-and-header-file-catenah)
+   - [Board-specific Classes](#board-specific-classes)
+   - [Class derivation](#class-derivation)
+      - [STM32 Classes](#stm32-classes)
+      - [SAMD Classes](#samd-classes)
+   - [Platform Management](#platform-management)
+      - [Platform GUIDs](#platform-guids)
+      - [GUIDs for the Catena 461x family](#guids-for-the-catena-461x-family)
+         - [Catena 4610](#catena-4610)
+         - [Catena 4612](#catena-4612)
+         - [Catena 4618](#catena-4618)
+         - [Catena 4630](#catena-4630)
+      - [GUIDs for the Catena 4450/4460/4470 family](#guids-for-the-catena-445044604470-family)
+         - [Catena 4450](#catena-4450)
+         - [Catena 4460](#catena-4460)
+         - [Catena 4470](#catena-4470)
+      - [GUIDs for the Catena 480x family](#guids-for-the-catena-480x-family)
+         - [Catena 4801](#catena-4801)
+         - [Catena 4802](#catena-4802)
+      - [GUIDs for Adafruit Feather M0s](#guids-for-adafruit-feather-m0s)
+   - [Polling Framework](#polling-framework)
+      - [Making a class pollable](#making-a-class-pollable)
+      - [Using pollable objects in sketches](#using-pollable-objects-in-sketches)
+   - [Finite State Machine FSM Framework](#finite-state-machine-fsm-framework)
+      - [Getting ready](#getting-ready)
+      - [Defining the state enum class](#defining-the-state-enum-class)
+      - [Identify the parent class](#identify-the-parent-class)
+      - [Add the state type to the parent class](#add-the-state-type-to-the-parent-class)
+      - [Define the FSM instance in the parent class](#define-the-fsm-instance-in-the-parent-class)
+      - [Declare a method function in the parent class](#declare-a-method-function-in-the-parent-class)
+      - [Implement the FSM dispatch function](#implement-the-fsm-dispatch-function)
+      - [Implement the FSM initialization](#implement-the-fsm-initialization)
+   - [The general time/date class McciCatena::cDate](#the-general-timedate-class-mccicatenacdate)
+      - [Interval Seconds](#interval-seconds)
+      - [cDate calendar types](#cdate-calendar-types)
+      - [cDate properties](#cdate-properties)
+      - [cDate methods](#cdate-methods)
+      - [Timekeeping, solar days, leap seconds](#timekeeping-solar-days-leap-seconds)
+   - [LoRaWAN Support](#lorawan-support)
+      - [Sending an uplink message](#sending-an-uplink-message)
+      - [Registering to receive downlink messages](#registering-to-receive-downlink-messages)
+      - [LoRaWAN Class Structure](#lorawan-class-structure)
+   - [FRAM Storage Management](#fram-storage-management)
+      - [FRAM Storage Formats](#fram-storage-formats)
+         - [Object Storage Structure](#object-storage-structure)
+         - [Bit layout of uSizeKey](#bit-layout-of-usizekey)
+         - [The FRAM header object](#the-fram-header-object)
+      - [Adding FRAM objects](#adding-fram-objects)
+      - [Class hierarchy within the FRAM library](#class-hierarchy-within-the-fram-library)
+   - [Asynchronous Serial Port Command Processing](#asynchronous-serial-port-command-processing)
+      - [Collecting lines asynchronously from streams](#collecting-lines-asynchronously-from-streams)
+      - [The command parser](#the-command-parser)
+      - [Command stream methods for use by functions](#command-stream-methods-for-use-by-functions)
+      - [Synchronous Command Functions](#synchronous-command-functions)
+      - [Asynchronous Command Functions](#asynchronous-command-functions)
+   - [Clock Management and Calibration](#clock-management-and-calibration)
+   - [Si1133 driver](#si1133-driver)
+   - [cTimer Timer object](#ctimer-timer-object)
+      - [Catena_Timer.h header file and initialization](#catena_timerh-header-file-and-initialization)
+      - [cTimer begin and end](#ctimer-begin-and-end)
+      - [Checking for cTimer events](#checking-for-ctimer-events)
+      - [cTimer Utility routines](#ctimer-utility-routines)
+   - [Catena_functional.h](#catena_functionalh)
+   - [cDownload](#cdownload)
+   - [cBootloaderApi](#cbootloaderapi)
+   - [cSerial](#cserial)
 - [Command Summary](#command-summary)
-        - [Standard commands](#standard-commands)
-        - [STM32L0 commands](#stm32l0-commands)
-        - [FRAM commands](#fram-commands)
-        - [LoRaWAN commands](#lorawan-commands)
-                - [LoRaWAN Parameters](#lorawan-parameters)
+	- [Standard commands](#standard-commands)
+	- [STM32L0 commands](#stm32l0-commands)
+	- [FRAM commands](#fram-commands)
+	- [LoRaWAN commands](#lorawan-commands)
+		- [LoRaWAN Parameters](#lorawan-parameters)
 - [Adding your own commands](#adding-your-own-commands)
 - [Example sketches](#example-sketches)
-        - [`catena_hello`](#catena_hello)
-        - [`catena_hello_lora`](#catena_hello_lora)
-        - [`catena_usercommand`](#catena_usercommand)
-        - [`catena_fsm`](#catena_fsm)
+	- [catena_hello](#catena_hello)
+	- [catena_hello_lora](#catena_hello_lora)
+	- [catena_usercommand](#catena_usercommand)
+	- [catena_fsm](#catena_fsm)
 - [Board Support Dependencies](#board-support-dependencies)
 - [Other Libraries and Versions Required](#other-libraries-and-versions-required)
 - [Release History](#release-history)
 - [Meta](#meta)
-        - [License](#license)
-        - [Support Open Source Hardware and Software](#support-open-source-hardware-and-software)
-        - [Trademarks](#trademarks)
+	- [License](#license)
+	- [Support Open Source Hardware and Software](#support-open-source-hardware-and-software)
+	- [Trademarks](#trademarks)
 
 <!-- /TOC -->
 <!-- markdownlint-restore -->
@@ -1377,8 +1377,8 @@ static cCommandStream::cDispatch sMyCommands(
     sMyCommmandTable,           // this is the pointer to the table
     sizeof(sMyCommmandTable),   // this is the size of the table
     "application"               // this is the "first word" for all the commands
-                                // in this table. If nullptr, then the commands
-                                // are added to the main table.
+				// in this table. If nullptr, then the commands
+				// are added to the main table.
     );
 ```
 
@@ -1452,7 +1452,8 @@ This sketch demonstrates the use of the Catena FSM class to implement the `Turns
 
 - HEAD includes the following changes
 
-  - Added a test-compile bash script, using [`arduino-cli`](https://arduino.github.io/arduino-cli/), [`extra/compile-all.sh`](extra/compile-all.sh).
+  - fix [#340](https://github.com/mcci-catena/Catena-Arduino-Platform/issues/340): Rename the old `extra/` directory to `extras/` to match the Arduino library spec.
+  - Added a test-compile bash script, using [`arduino-cli`](https://arduino.github.io/arduino-cli/), [`extras/compile-all.sh`](extras/compile-all.sh).
   - fix [#339](https://github.com/mcci-catena/Catena-Arduino-Platform/issues/339): remove support for never-released Catena models (4551, 4611, 4617).
   - fix [#338](https://github.com/mcci-catena/Catena-Arduino-Platform/issues/338): missing return in `eraseBlock32()`.
   - fix [#336](https://github.com/mcci-catena/Catena-Arduino-Platform/issues/336): fix a number of warnings thrown by `-Wall`.

diff --git a/extra/compile-all.sh → extras/compile-all.sh b/extra/compile-all.sh → extras/compile-all.sh
diff --git a/extra/make-lorawan-keys-entry.sh → extras/make-lorawan-keys-entry.sh b/extra/make-lorawan-keys-entry.sh → extras/make-lorawan-keys-entry.sh
diff --git a/...ora_adr_rejoin/catena_lora_adr_rejoin.ino → ...ora_adr_rejoin/catena_lora_adr_rejoin.ino b/...ora_adr_rejoin/catena_lora_adr_rejoin.ino → ...ora_adr_rejoin/catena_lora_adr_rejoin.ino
diff --git a/src/lib/samd/catena4410/Catena4410_gk_lorawan_keys.cpp b/src/lib/samd/catena4410/Catena4410_gk_lorawan_keys.cpp
@@ -40,7 +40,7 @@ using namespace McciCatena;
 
 /*
 
-Use the script extra/make-lorawan-keys-entry.sh to generate
+Use the script extras/make-lorawan-keys-entry.sh to generate
 the entries in this table.
 
 */