MPAE-15106: Grammar edits

Author: robertperkel

README.md

@@ -4,7 +4,7 @@
 
 # User Interface Co-Processor with PIC16F18146
 
-This example uses the PIC16F18146 to act as a user-interface co-processor, where the MCU debounces a pushbutton, performs quadrature decoding, and generates 4 programmable PWM channels. As the functionality of this example is developed in software, it can be customized to the design.
+This example uses the PIC16F18146 to work as a user-interface co-processor, where the MCU debounces a push button, performs quadrature decoding, and generates 4 programmable PWM channels. As the functionality of this example is developed in software, it can be customized to the design.
 
 ## Related Documentation
 
@@ -30,7 +30,7 @@ This example uses the PIC16F18146 to act as a user-interface co-processor, where
 
 ## Setup
 
-With the power off, install the PIC16F18146 into the socket of the Curiosity LPC board, while matching the pin 1 marker on the DIP and PCB (marked as 1).
+Disconnect power to the LPC board. Install the PIC16F18146 into the socket of the Curiosity LPC board, while matching pin 1 on the DIP and PCB (indicated by the 1 in the image below).
 
 ![Curiosity LPC](./images/LPC.png)
 
@@ -42,9 +42,9 @@ With the power off, install the PIC16F18146 into the socket of the Curiosity LPC
 | RB6  | SDA, I<sup>2</sup>C Data Line
 | GND | Connect the ground of the MCP2221A to the LPC board.
 
-*Important: Match the voltage of the MCP2221A breakout to the setting on the Curiosity LPC (marked as 2). Either +5V or 3.3V can be used, depending on the circuit requirements. Do NOT connect power from the MCP2221A to the LPC.*
+*Important: Match the voltage of the MCP2221A breakout to the setting on the Curiosity LPC, marked as 2. Either +5V or 3.3V can be used, depending on the circuit requirements. Do NOT connect power from the MCP2221A to the LPC.*
 
-Next, follow the application circuit of the encoder (if provided), and connect the encoder as follows.
+If provided, follow the application circuit of the encoder, and connect the encoder as follows.  
 
 | IO Pin | Description
 | ------ | ----------
@@ -57,11 +57,11 @@ Next, follow the application circuit of the encoder (if provided), and connect t
 
 ### Built-In (Pre-wired) Features
 
-For the pushbutton, the button built-in to the LPC is used (S1). No wiring is required. Pin RC6 is the debounced output, which is viewable on an oscilloscope. 
+No wiring is required for the push button built-in to the LPC (S1). Pin RC6 is a debounced output that can be viewed on an oscilloscope.
 
 | IO Pin | Description
 | ------ | ----------
-| RC4 | Pushbutton Input (S1)
+| RC4 | Push button Input (S1)
 | RC6 | Debounced Output (*Optional, Connect to oscilloscope with ground for testing*)
 
 *Note: It was difficult to generate any bounces from S1. Bounces can be easily generated by connecting a piece of wire to RC4 and tapping it on a grounded pin or connection.*
@@ -83,7 +83,7 @@ To demonstrate the PWM controls, the LEDs on the LPC are connected to the output
 | RB6  | SDA, I<sup>2</sup>C Data Line
 | RC0 | Quadrature Decoder "A" Input
 | RC1 | Quadrature Decoder "B" Input
-| RC4 | Pushbutton Input (S1)
+| RC4 | Push button Input (S1)
 | RC6 | Debounced Output (*Optional, Connect to oscilloscope with ground for testing*)
 | RC5 | PWM_CH1 (PWM1, Phase 1)
 | RA2 | PWM_CH2 (PWM1, Phase 2)
@@ -97,7 +97,7 @@ This application implements a simple user-interface co-processor for an embedded
 This proof-of-concept project implements 3 key functions for the main processor:
  - Decoding quadrature signals from rotary encoders
  - Generating 4 PWM waveforms
- - Debouncing a pushbutton
+ - Debouncing a push button
 
 As this application is software defined, the exact functionality can be customized to meet the requirements of the system.
 
@@ -123,7 +123,7 @@ The PWM waveforms are generated by Core Independent Peripherals (CIP), which ope
 
 ### Debouncing a Button
 
-Pushbuttons and switches exhibit a temporary "bounce" when pressed or released. These bounces create brief periods of instability that would confuse the system if not filtered out. 
+Push buttons and switches exhibit a temporary "bounce" when pressed or released. These bounces create brief periods of instability that would confuse the system if not filtered out. 
 
 In this example, a hardware-level button debouncer is implemented using hardware peripherals. To implement this functionality, 2 CLCs and the Numerically Controlled Oscillator (NCO) CIPs are used. The NCO generates a low-frequency clock (200 Hz) for the CLCs, while the CLCs perform basic digital filtering, as shown below.
 
@@ -135,13 +135,13 @@ In this example, a hardware-level button debouncer is implemented using hardware
 
 ### I<sup>2</sup>C Interface
 
-To communicate with the device, I<sup>2</sup>C is used. This device is setup as an I<sup>2</sup>C client with an address of 0x40. (The address can be changed in software).
+This device is setup as an I<sup>2</sup>C Client with an address of 0x40. (The address can be changed in software).
 
- When I<sup>2</sup>C is not active, the device is in sleep to save power. 
+ When the I<sup>2</sup>C is not active, the device goes into Sleep mode to save power. 
 
 #### Writing Data
 
-To configure the device, perform an I<sup>2</sup>C write to the device. Writes take the form as:
+Perform an I<sup>2</sup>C write for the device to configure it, as shown in the example below:
 
 ![I2C Write Example](./images/i2cWrite.png)
 
@@ -164,27 +164,27 @@ A list of the virtual registers is shown below.
 
 #### Reading Data
 
-To get the net change from the quadrature decider, perform an I<sup>2</sup>C read. The bytes read from the device are in int16_t format, with the 1st byte being the high byte, and the 2nd byte being the low byte. An example is shown below, with 2 back-to-back reads:
+To get the net change from the quadrature decoder, perform an I<sup>2</sup>C read. The bytes read from the device are in int16_t format, with the 1st byte being the high byte and the 2nd byte being the low byte. An example is shown below, with 2 back-to-back reads:
 
 ![I2C Read Example](./images/i2cRead.png)
 
 *Note: The application automatically zeros the net change after each read.*
 
-When the high-byte is read, the microcontroller computes the net rotation. This ensures the value doesn't rollover while a read is happening. After the low-byte, the system will repeat the operation above, but with the net rotation since the last read. 
+When the high byte is read, the microcontroller computes the net rotation. This ensures the value doesn't rollover while a read is performed. After the low byte, the system will repeat the operation above, but with the net rotation since the last read. 
 
-*Note: Very long byte read sequences with the MCP2221A seem to fail, likely due to insufficent clock stretching time for the client. Be sure to give the device time to respond.*
+*Note: Very long byte read sequences with the MCP2221A seem to fail, likely due to insufficent clock stretching time for the Client. Time must be given for the device to respond.*
 
 #### Setting Up PWM
 
 For each channel of PWM, there is an associated period and duty cycle register. These settings can be set independently of each other, or at the same time. The PWM is internally loaded and started at the same time to keep the channels as synchronized as possible.
 
 **Note: Setting the channels to differing frequencies is likely to break synchronization.**
 
-Consult the PWM chapter of the datasheet for more information about the PWM.
+Consult the PWM chapter of the data sheet for more information about the PWM.
 
 ##### Frequency Setup
 
-The PWM Core Independent Peripheral (CIP) generate 2 outputs for each instance of the peripheral. These instances share the same frequency, but different duty cycles. The period register determines the max count in the PWM timer. For instance, setting a period of 10, would limit the count to 10 or less. Each time the clock source (LFINTOSC, 31 kHz) goes high, the counter increments.
+The PWM CIP generates 2 outputs for each peripheral. These outputs share the same frequency, but can have differing duty cycles. The period register determines the max count in the PWM timer. For instance, setting a period of 10 would limit the count to 10 or less. Each time the clock source (LFINTOSC, 31 kHz) goes high, the counter increments.
 
 To determine the value to write for a given frequency, divide the clock source frequency by the desired target. As an example, if the desired output was 100 Hz, then write 310 (0x01, 0x36) to the register.