Skip to content

Commit 914f38a

Browse files
mattairtechmattairtech
committed
Updated documentation
1 parent 52f9b50 commit 914f38a

File tree

7 files changed

+637
-258
lines changed

7 files changed

+637
-258
lines changed

‎README.md

Lines changed: 420 additions & 254 deletions
Large diffs are not rendered by default.

‎bootloaders/zero/binaries/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ This directory contains the SAM-BA m0+ bootloaders built by the
44
build_all_bootloaders.sh script from the 'MattairTech SAM M0+
55
Boards' Arduino core, which is available at
66
https://github.com/mattairtech/ArduinoCore-samd.
7-
Note that the link above might not correspond to these binaries.
8-
I've released the binaries before the core. These binaries are from
9-
core version 1.6.8-beta-b0.
107

118
## MattairTech Boards
129
MattairTech boards are all configured with only one interface:

‎variants/Generic_D11C14A/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,57 @@ Arduino | Port | Alternate Function | Comments (! means not used with this perip
9898
* SERCOM2 does not exist on the D11C14A.
9999

100100

101+
# Board Configuration Notes
102+
103+
TODO: Update this for Generic D11C14A
104+
105+
* Either the 32.768KHz crystal or the 16MHz crystal can be used.
106+
* The bootloader does not use an external crystal by default. Double-tap the reset button to enter.
107+
108+
* **Digital: All pins can be used for general purpose I/O**
109+
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
110+
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
111+
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
112+
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
113+
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
114+
* These are available using the analogRead() function.
115+
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
116+
* Each pin provides 10 bits of resolution (1024 values) by default.
117+
* 12-bit resolution supported by using the analogReadResolution() function.
118+
* Each pin measures from ground to 3.3 volts.
119+
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
120+
* **DAC: One analog output is available on pin 2.**
121+
* Provides a 10-bit voltage output with the analogWrite() function.
122+
* **PWM: 12 pins (MT-D21E) or 8 pins (MT-D11) can be configured as PWM outputs.**
123+
* Available using the analogWrite() function.
124+
* Each pin provides 8 bits of resolution (256 values) by default.
125+
* 12-bit resolution supported by using the analogWriteResolution() function.
126+
* **External Interrupts: 15 pins (MT-D21E) or 9 pins (MT-D11) can be configured with external interrupts.**
127+
* Available using the attachInterrupt() function.
128+
* **Serial: 2 pairs of pins (MT-D21E) or 1 pair (MT-D11) can be configured for TTL serial I/O.**
129+
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
130+
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
131+
* **SPI: 3 or 4 pins can be configured for SPI I/O (SPI).**
132+
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
133+
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
134+
* SPI communication using the SPI library.
135+
* Note that the SPI library will set SS as an output.
136+
* On the MT-D11, the button must be configured as reset (default) when using SPI.
137+
* **TWI (I2C): 2 pins can be configured for TWI I/O (Wire).**
138+
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
139+
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
140+
* TWI communication using the Wire library.
141+
* **LED: One pin can be configured to light the onboard LED (LED_BUILTIN).**
142+
* Pin 28 (MT-D21E) or pin 16 (MT-D11). Bring the pin HIGH to turn the LED on. The pullup is disabled on this pin.
143+
* **Button: One pin can be configured to read the onboard Button A (BUTTON_BUILTIN).**
144+
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
145+
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
146+
* **AREF: One pin can be configured as an AREF analog input.**
147+
* The upper end of the analog measurement range can be changed using the analogReference() function.
148+
* **Reset: Bring this line LOW to reset the microcontroller.**
149+
150+
151+
101152
# PinDescription table format
102153

103154
## Note that a new column (GCLKCCL) was added for 1.6.8-beta-b0.

‎variants/MT_D11/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,61 @@ Arduino | Silk | Port | Alternate Function | Comments (! means not used with thi
102102
* The tone library uses TC2.
103103

104104

105+
# Board Configuration Notes
106+
107+
TODO: Update this
108+
109+
* Either the 32.768KHz crystal or the 16MHz crystal can be used. Be sure to set the correct solder jumpers.
110+
* The bootloader does not use an external crystal by default. Double-tap the reset button to enter.
111+
* The button is connected to the Reset pin by default, but can be connected to pin 15 via the solder jumper.
112+
* BTN pin is shared with SPI SS, so the button must be configured as reset (default) when using SPI.
113+
* A reference voltage can be connected to REFA or REFB. In these cases, the capacitors should be enabled via the solder jumpers.
114+
* The I2C (TWI) pullup resistors are enabled by default.
115+
* The LED is enabled by default.
116+
117+
* **Digital: All pins can be used for general purpose I/O**
118+
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
119+
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
120+
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
121+
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
122+
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
123+
* These are available using the analogRead() function.
124+
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
125+
* Each pin provides 10 bits of resolution (1024 values) by default.
126+
* 12-bit resolution supported by using the analogReadResolution() function.
127+
* Each pin measures from ground to 3.3 volts.
128+
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
129+
* **DAC: One analog output is available on pin 2.**
130+
* Provides a 10-bit voltage output with the analogWrite() function.
131+
* **PWM: 12 pins (MT-D21E) or 8 pins (MT-D11) can be configured as PWM outputs.**
132+
* Available using the analogWrite() function.
133+
* Each pin provides 8 bits of resolution (256 values) by default.
134+
* 12-bit resolution supported by using the analogWriteResolution() function.
135+
* **External Interrupts: 15 pins (MT-D21E) or 9 pins (MT-D11) can be configured with external interrupts.**
136+
* Available using the attachInterrupt() function.
137+
* **Serial: 2 pairs of pins (MT-D21E) or 1 pair (MT-D11) can be configured for TTL serial I/O.**
138+
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
139+
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
140+
* **SPI: 3 or 4 pins can be configured for SPI I/O (SPI).**
141+
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
142+
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
143+
* SPI communication using the SPI library.
144+
* Note that the SPI library will set SS as an output.
145+
* On the MT-D11, the button must be configured as reset (default) when using SPI.
146+
* **TWI (I2C): 2 pins can be configured for TWI I/O (Wire).**
147+
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
148+
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
149+
* TWI communication using the Wire library.
150+
* **LED: One pin can be configured to light the onboard LED (LED_BUILTIN).**
151+
* Pin 28 (MT-D21E) or pin 16 (MT-D11). Bring the pin HIGH to turn the LED on. The pullup is disabled on this pin.
152+
* **Button: One pin can be configured to read the onboard Button A (BUTTON_BUILTIN).**
153+
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
154+
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
155+
* **AREF: One pin can be configured as an AREF analog input.**
156+
* The upper end of the analog measurement range can be changed using the analogReference() function.
157+
* **Reset: Bring this line LOW to reset the microcontroller.**
158+
159+
105160

106161
# PinDescription table format
107162

‎variants/MT_D21E/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,61 @@ Arduino | Silk | Port | Alternate Function | Comments (! means not used with thi
8484
* Leave pin A30 floating (or use external pullup) during reset.
8585

8686

87+
# Board Configuration Notes
88+
89+
TODO: Update this
90+
91+
* Either the 32.768KHz crystal or the 16MHz crystal can be used. Be sure to set the correct solder jumpers.
92+
* The bootloader does not use an external crystal by default. Double-tap the reset button to enter.
93+
* The button is connected to the Reset pin by default, but can be connected to pin 15 via the solder jumper.
94+
* BTN pin is shared with SPI SS, so the button must be configured as reset (default) when using SPI.
95+
* A reference voltage can be connected to REFA or REFB. In these cases, the capacitors should be enabled via the solder jumpers.
96+
* The I2C (TWI) pullup resistors are enabled by default.
97+
* The LED is enabled by default.
98+
99+
* **Digital: All pins can be used for general purpose I/O**
100+
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
101+
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
102+
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
103+
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
104+
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
105+
* These are available using the analogRead() function.
106+
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
107+
* Each pin provides 10 bits of resolution (1024 values) by default.
108+
* 12-bit resolution supported by using the analogReadResolution() function.
109+
* Each pin measures from ground to 3.3 volts.
110+
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
111+
* **DAC: One analog output is available on pin 2.**
112+
* Provides a 10-bit voltage output with the analogWrite() function.
113+
* **PWM: 12 pins (MT-D21E) or 8 pins (MT-D11) can be configured as PWM outputs.**
114+
* Available using the analogWrite() function.
115+
* Each pin provides 8 bits of resolution (256 values) by default.
116+
* 12-bit resolution supported by using the analogWriteResolution() function.
117+
* **External Interrupts: 15 pins (MT-D21E) or 9 pins (MT-D11) can be configured with external interrupts.**
118+
* Available using the attachInterrupt() function.
119+
* **Serial: 2 pairs of pins (MT-D21E) or 1 pair (MT-D11) can be configured for TTL serial I/O.**
120+
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
121+
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
122+
* **SPI: 3 or 4 pins can be configured for SPI I/O (SPI).**
123+
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
124+
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
125+
* SPI communication using the SPI library.
126+
* Note that the SPI library will set SS as an output.
127+
* On the MT-D11, the button must be configured as reset (default) when using SPI.
128+
* **TWI (I2C): 2 pins can be configured for TWI I/O (Wire).**
129+
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
130+
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
131+
* TWI communication using the Wire library.
132+
* **LED: One pin can be configured to light the onboard LED (LED_BUILTIN).**
133+
* Pin 28 (MT-D21E) or pin 16 (MT-D11). Bring the pin HIGH to turn the LED on. The pullup is disabled on this pin.
134+
* **Button: One pin can be configured to read the onboard Button A (BUTTON_BUILTIN).**
135+
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
136+
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
137+
* **AREF: One pin can be configured as an AREF analog input.**
138+
* The upper end of the analog measurement range can be changed using the analogReference() function.
139+
* **Reset: Bring this line LOW to reset the microcontroller.**
140+
141+
87142

88143
# PinDescription table format
89144

‎variants/MT_D21E_revB/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,61 @@ Arduino | Silk | Port | Alternate Function | Comments (! means not used with thi
9696
* Leave pin A30 floating (or use external pullup) during reset.
9797

9898

99+
# Board Configuration Notes
100+
101+
TODO: Update this
102+
103+
* Either the 32.768KHz crystal or the 16MHz crystal can be used. Be sure to set the correct solder jumpers.
104+
* The bootloader does not use an external crystal by default. Double-tap the reset button to enter.
105+
* The button is connected to the Reset pin by default, but can be connected to pin 15 via the solder jumper.
106+
* BTN pin is shared with SPI SS, so the button must be configured as reset (default) when using SPI.
107+
* A reference voltage can be connected to REFA or REFB. In these cases, the capacitors should be enabled via the solder jumpers.
108+
* The I2C (TWI) pullup resistors are enabled by default.
109+
* The LED is enabled by default.
110+
111+
* **Digital: All pins can be used for general purpose I/O**
112+
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
113+
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
114+
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
115+
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
116+
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
117+
* These are available using the analogRead() function.
118+
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
119+
* Each pin provides 10 bits of resolution (1024 values) by default.
120+
* 12-bit resolution supported by using the analogReadResolution() function.
121+
* Each pin measures from ground to 3.3 volts.
122+
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
123+
* **DAC: One analog output is available on pin 2.**
124+
* Provides a 10-bit voltage output with the analogWrite() function.
125+
* **PWM: 12 pins (MT-D21E) or 8 pins (MT-D11) can be configured as PWM outputs.**
126+
* Available using the analogWrite() function.
127+
* Each pin provides 8 bits of resolution (256 values) by default.
128+
* 12-bit resolution supported by using the analogWriteResolution() function.
129+
* **External Interrupts: 15 pins (MT-D21E) or 9 pins (MT-D11) can be configured with external interrupts.**
130+
* Available using the attachInterrupt() function.
131+
* **Serial: 2 pairs of pins (MT-D21E) or 1 pair (MT-D11) can be configured for TTL serial I/O.**
132+
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
133+
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
134+
* **SPI: 3 or 4 pins can be configured for SPI I/O (SPI).**
135+
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
136+
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
137+
* SPI communication using the SPI library.
138+
* Note that the SPI library will set SS as an output.
139+
* On the MT-D11, the button must be configured as reset (default) when using SPI.
140+
* **TWI (I2C): 2 pins can be configured for TWI I/O (Wire).**
141+
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
142+
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
143+
* TWI communication using the Wire library.
144+
* **LED: One pin can be configured to light the onboard LED (LED_BUILTIN).**
145+
* Pin 28 (MT-D21E) or pin 16 (MT-D11). Bring the pin HIGH to turn the LED on. The pullup is disabled on this pin.
146+
* **Button: One pin can be configured to read the onboard Button A (BUTTON_BUILTIN).**
147+
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
148+
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
149+
* **AREF: One pin can be configured as an AREF analog input.**
150+
* The upper end of the analog measurement range can be changed using the analogReference() function.
151+
* **Reset: Bring this line LOW to reset the microcontroller.**
152+
153+
99154

100155
# PinDescription table format
101156

‎variants/MT_D21E_revB/variant.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ extern "C"
141141
*/
142142
#define JUMPER_A (27u)
143143
#define BUTTON_B (31u)
144-
#define BUTTON_BUILTIN BUTTON_A
144+
#define BUTTON_BUILTIN BUTTON_B
145145

146146

147147
/*

0 commit comments

Comments
 (0)