Skip to content

Commit a2f0930

Browse files
committed
Minor documentation update
1 parent 6e2034c commit a2f0930

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

README.md

+44-44
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,27 @@ DC Current per I/O Pin | 7 mA | 7 mA
6363

6464
## Special Notes
6565

66-
* Boards Manager may require opening twice (with possibly a delay in between) to see some updates.
66+
* ** Boards Manager must be opened twice to see some updates **
6767

68-
* Errors when compiling, uploading, or burning the bootloader
69-
Be sure to install the Arduino samd core before installing the MattairTech samd core. If you have problems upgrading
68+
* ** Errors when compiling, uploading, or burning the bootloader **
69+
* Be sure to install the Arduino samd core before installing the MattairTech samd core. If you have problems upgrading
7070
the IDE to 1.6.6, you may need to uninstall both the Arduino and MattairTech cores, then re-install in the proper order.
7171
Use Arduino core 1.6.2 or above.
7272

73-
* Tools->Communications menu
74-
Currently, the Tools->Communications menu must be used to select the communications configuration. This configuration
73+
* ** Tools->Communications menu **
74+
* Currently, the Tools->Communications menu must be used to select the communications configuration. This configuration
7575
must match the included libraries. For example, when including the HID and Keyboard libraries, you must select an
7676
option that includes HID (ie: CDC_HID_UART). This menu is currently needed to select the USB PID that matches the
7777
USB device configuration (needed for Windows). This may become automatic in a future release.
7878

79-
* Be sure that the Tools->Communications menu matches the sketch and libraries you are compiling.
80-
* Different combinations of USB devices will result in different COM port assingments in Windows.
79+
* Be sure that the Tools->Communications menu matches the sketch and libraries you are compiling.
80+
* Different combinations of USB devices will result in different COM port assingments in Windows.
8181

82-
* Incude platform specific libraries
83-
You may need to manually include platform specific libraries such as SPI.h, Wire.h, and HID.h.
82+
* ** Incude platform specific libraries **
83+
* You may need to manually include platform specific libraries such as SPI.h, Wire.h, and HID.h.
8484

85-
* Differences from Arduino in versioning
86-
The MattairTech ArduinoCore-samd version currently tracks the IDE version. In some cases, it may indicate the
85+
* ** Differences from Arduino in versioning **
86+
* The MattairTech ArduinoCore-samd version currently tracks the IDE version. In some cases, it may indicate the
8787
minimum IDE version. This is the case for both 1.6.5-mtX and 1.6.6-mtX (which corresponds to SAMD CORE 1.6.2).
8888
1.6.6-mt1 corresponds to Arduino SAMD CORE 1.6.2 plus some pull requests.
8989

@@ -149,57 +149,57 @@ BTN/SS 15(INT1) 15 15(ADC7) | A15 RST |
149149
### Pin Capabilities
150150

151151
* **Digital: All pins can be used for general purpose I/O**
152-
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
153-
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
154-
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
155-
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
156-
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
157-
* These are available using the analogRead() function.
158-
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
159-
* Each pin provides 10 bits of resolution (1024 values) by default.
160-
* 12-bit resolution supported by using the analogReadResolution() function.
161-
* Each pin measures from ground to 3.3 volts.
162-
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
152+
* Supports INPUT, OUTPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
153+
* Each pin can source or sink a maximum of 7 mA (when PER_ATTR_DRIVE_STRONG is set for the pin).
154+
* Internal pull-up and pull-down resistors of 20-60 Kohms (40Kohm typ., disconnected by default).
155+
* Use the pinMode(), digitalWrite(), and digitalRead() functions.
156+
* **Analog Inputs: 10 pins can be configured as ADC analog inputs.**
157+
* These are available using the analogRead() function.
158+
* All pins can be used for GPIO and some pins can be used for other digital functions (ie. pwm or serial).
159+
* Each pin provides 10 bits of resolution (1024 values) by default.
160+
* 12-bit resolution supported by using the analogReadResolution() function.
161+
* Each pin measures from ground to 3.3 volts.
162+
* The upper end of the measurement range can be changed using the AREF pin and the analogReference() function.
163163
* **DAC: One analog output is available on pin 2.**
164-
* Provides a 10-bit voltage output with the analogWrite() function.
164+
* Provides a 10-bit voltage output with the analogWrite() function.
165165
* **PWM: 12 pins (MT-D21E) or 8 pins (MT-D11) can be configured as PWM outputs.**
166-
* Available using the analogWrite() function.
167-
* Each pin provides 8 bits of resolution (256 values) by default.
168-
* 12-bit resolution supported by using the analogWriteResolution() function.
166+
* Available using the analogWrite() function.
167+
* Each pin provides 8 bits of resolution (256 values) by default.
168+
* 12-bit resolution supported by using the analogWriteResolution() function.
169169
* **External Interrupts: 15 pins (MT-D21E) or 9 pins (MT-D11) can be configured with external interrupts.**
170-
* Available using the attachInterrupt() function.
170+
* Available using the attachInterrupt() function.
171171
* **Serial: 2 pairs of pins (MT-D21E) or 1 pair (MT-D11) can be configured for TTL serial I/O.**
172-
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
173-
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
172+
* MT-D21E: Serial1: pin 11 (RX) and pin 10 (TX). Serial2: pin 15 (RX) and pin 14 (TX).
173+
* MT-D11: Serial1: pin 31 (RX) and pin 30 (TX).
174174
* **SPI: 3 or 4 pins can be configured for SPI I/O (SPI).**
175-
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
176-
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
177-
* SPI communication using the SPI library.
178-
* Note that the SPI library will set SS as an output.
179-
* On the MT-D11, the button must be configured as reset (default) when using SPI.
175+
* MT-D21E: Pin 18 (MOSI), pin 19 (SCK), pin 22 (MISO), and optionally pin 23 (SS, not currently used).
176+
* MT-D11: Pin 10 (MOSI), pin 11 (SCK), pin 14 (MISO), and optionally pin 15 (SS, not currently used).
177+
* SPI communication using the SPI library.
178+
* Note that the SPI library will set SS as an output.
179+
* On the MT-D11, the button must be configured as reset (default) when using SPI.
180180
* **TWI (I2C): 2 pins can be configured for TWI I/O (Wire).**
181-
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
182-
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
183-
* TWI communication using the Wire library.
181+
* MT-D21E: Pin 16 (SDA) and pin 17 (SCL).
182+
* MT-D11: Pin 22 (SDA) and pin 23 (SCL).
183+
* TWI communication using the Wire library.
184184
* **LED: One pin can be configured to light the onboard LED (LED_BUILTIN).**
185-
* 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.
185+
* 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.
186186
* **Button: One pin can be configured to read the onboard Button A (BUTTON_BUILTIN).**
187-
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
188-
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
187+
* Pin 27 (MT-D21E) or pin 15 (MT-D11). Pressing the button will bring the pin LOW. The pullup must be enabled first.
188+
* If the debouncing capacitor is connected, delay reading the pin at least 6ms after turning on the pullup.
189189
* **AREF: One pin can be configured as an AREF analog input.**
190-
* The upper end of the analog measurement range can be changed using the analogReference() function.
190+
* The upper end of the analog measurement range can be changed using the analogReference() function.
191191
* **Reset: Bring this line LOW to reset the microcontroller.**
192192

193193
### MT-D21E and MT-D11 Board Configuration Notes
194194

195195
* The 32.768KHz crystal is used by the Arduino core, so it MUST be connected via the solder jumpers.
196-
* Note that the sketch may still run without the crystal attached, but the clock speed will be very inaccurate.
196+
* The sketch in some cases can run without the crystal attached, but the clock will be very inaccurate.
197197
* The 16MHz crystal is not used. It should be disconnected via the solder jumpers.
198198
* The I2C (TWI) pullup resistors should be enabled via the solder jumpers.
199199
* The LED should be enabled via the solder jumper.
200-
* Button A should be connected via the solder jumper. The debouncing capacitor should also be connected.
200+
* Button A and the debouncing capacitor should be connected via the solder jumpers.
201201
* Button B (MT-D21E only) is connected to the Reset pin by default, but can be connected to pin 31 via the solder jumper.
202-
* A reference voltage can be connected to AREF. In this case, the capacitors should be enabled via the solder jumper.
202+
* A reference voltage can be connected to AREF. In this case, the capacitors should be enabled via the solder jumpers.
203203
* On the MT-D11, BTN is shared with SPI SS, so the button must be configured as reset (default) when using SPI.
204204

205205

0 commit comments

Comments
 (0)