diff --git a/apix-adc-example/README.md b/apix-adc-example/README.md index cd24ed9..cad57cd 100644 --- a/apix-adc-example/README.md +++ b/apix-adc-example/README.md @@ -1,16 +1,16 @@ -Digi APIX ADC Sample Application +Digi APIX ADC Example Application =================================== -Sample application to access and manage ADC channels using the Digi APIX library. +Example application to access and manage ADC channels using the Digi APIX library. -The application enables one ADC channel on the board. After that, the application -takes periodic samples and prints the raw value and the value in mv. +This application enables one ADC channel on the board. After that, the +application takes periodic samples and prints the raw value and the value in mv. -The ADC lines used in the sample are mapped as follows in the Digi Boards: - - **CCIMX6 SBC**: PMIC_ADCIN1 (GPIO Connector Pin 1). - - **CCIMX6Plus SBC**: PMIC_ADCIN1 (GPIO Connector Pin 1). - - **CCIMX6UL SBC Express**: ADC1_IN4 (Expansion Connector Pin 7). - - **CCIMX6UL SBC Pro**: ADC1_IN2 (GPIO Connector Pin 13). +The ADC lines used in this example are mapped as follows in the Digi boards: + - **ConnectCore 6 SBC**: PMIC_ADCIN1 (GPIO connector, J30, Pin 1). + - **ConnectCore 6 Plus SBC**: PMIC_ADCIN1 (GPIO connector, J30, Pin 1). + - **ConnectCore 6UL SBC Express**: ADC1_IN4 (Expansion connector, J8, Pin 7). + - **ConnectCore 6UL SBC Pro**: ADC1_IN2 (GPIO connector, J30, Pin 13). Running the application ----------------------- @@ -32,7 +32,7 @@ Alias for ADC can be configured in the library config file ``` If no arguments are provided, the example will use the default values: - - For the interfaces, default values are configured in "/etc/libdigiapix.conf" + - For the interfaces, default values are configured in `/etc/libdigiapix.conf`. - Specific application default values are defined in the main file. Compiling the application diff --git a/apix-gpio-example/README.md b/apix-gpio-example/README.md index eac6acf..e8f3b8e 100644 --- a/apix-gpio-example/README.md +++ b/apix-gpio-example/README.md @@ -1,21 +1,24 @@ Digi APIX GPIO Example Application ================================== -The example application uses a gpio as input (e.g. a user button) and another + +Example application to access and manage GPIO lines using the Digi APIX library. + +This application uses a GPIO as input (e.g. a user button) and another one as output (e.g. a user led). The application toggles the output GPIO whenever an interrupt is generated in the input GPIO. -The GPIOs lines used in the sample are mapped as follows in the Digi Boards: - - **CCIMX6 SBC**: - - User button: EXP_GPIO_0 (GPIO Connector Pin 6) +The GPIOs lines used in this example are mapped as follows in the Digi boards: + - **ConectCore 6 SBC**: + - User button: EXP_GPIO_0 (GPIO connector, J30, Pin 6) - User led: USER_LED0 (Connected in the board) - - **CCIMX6Plus SBC**: - - User button: EXP_GPIO_0 (GPIO Connector Pin 6) + - **ConnectCore 6 Plus SBC**: + - User button: EXP_GPIO_0 (GPIO connector, J30, Pin 6) - User led: USER_LED0 (Connected in the board) - - **CCIMX6UL SBC Express**: + - **ConnectCore 6UL SBC Express**: - User button: GPIO3_IO3 (Connected in the board) - User led: GPIO3_IO11 (Connected in the board) - - **CCIMX6UL SBC Pro**: - - User button: MCA_IO1 (GPIO Connector Pin 7) + - **ConnectCore 6UL SBC Pro**: + - User button: MCA_IO1 (GPIO connector, J30, Pin 7) - User led: USER_LED1 (Connected in the board) Running the application @@ -35,7 +38,7 @@ Aliases for GPIO numbers can be configured in the library config file ``` If no arguments are provided, the example will use the default values: - - For the interfaces, default values are configured in "/etc/libdigiapix.conf" + - For the interfaces, default values are configured in `/etc/libdigiapix.conf`. - Specific application default values are defined in the main file. Compiling the application diff --git a/apix-i2c-example/README.md b/apix-i2c-example/README.md index 9e046d4..4d05c1e 100644 --- a/apix-i2c-example/README.md +++ b/apix-i2c-example/README.md @@ -1,28 +1,28 @@ -Digi APIX I2C Sample Application +Digi APIX I2C Example Application ================================= -Sample application to access and manage I2C slaves using the Digi APIX library. +Example application to access and manage I2C slaves using the Digi APIX library. -The application writes a page of an external EEPROM memory with random -data and then reads the data back to validate it (tested with 24FC1026). +This application writes a page of an external EEPROM memory with random data. +Afterward, it reads the data back to validate it (tested with 24FC1026). -The I2C connections for the sample depend on the running platform: - - **CCIMX6 SBC**: I2C connector of the board. +The I2C connections for this example depend on the running platform: + - **ConnectCore 6 SBC**: I2C connector of the board (J28). - VCC: Pin 3 - GND: Pin 6 - I2C-3 SDA: Pin 2 - I2C-3 SCL: Pin 1 - - **CCIMX6Plus SBC**: I2C connector of the board. + - **ConnectCore 6 Plus SBC**: I2C connector of the board (J28). - VCC: Pin 3 - GND: Pin 6 - I2C-3 SDA: Pin 2 - I2C-3 SCL: Pin 1 - - **CCIMX6UL SBC Express**: Expansion connector of the board. + - **ConnectCore 6UL SBC Express**: Expansion connector of the board (J8). - VCC: Pin 1 - GND: Pin 6 - I2C-1 SDA: Pin 3 - I2C-1 SCL: Pin 5 - - **CCIMX6UL SBC Pro**: I2C connector of the board. + - **ConnectCore 6UL SBC Pro**: I2C connector of the board (J28). - VCC: Pin 3 - GND: Pin 6 - I2C-2 SDA: Pin 2 @@ -47,7 +47,7 @@ Usage: apix-i2c-example - Digi APIX ADC Sample + Digi APIX ADC Example -Sample application to access and manage ADC channels using the Digi APIX library. -The application enables one ADC channel on the board. After that, the application takes periodic samples and prints the raw value and the value in mv. +Example application to access and manage ADC channels using the Digi APIX library. +This application enables one ADC channel on the board. After that, the +application takes periodic samples and prints the raw value and the value in mv. apix-adc-example @@ -15,10 +16,10 @@ The application enables one ADC channel on the board. After that, the applicatio - Digi APIX GPIO Sample + Digi APIX GPIO Example -Sample application to access and manage GPIO lines using the Digi APIX library. -The application uses a gpio as input (e.g. a user button) and another +Example application to access and manage GPIO lines using the Digi APIX library. +This application uses a GPIO as input (e.g. a user button) and another one as output (e.g. a user led). The application toggles the output GPIO whenever an interrupt is generated in the input GPIO. @@ -31,11 +32,11 @@ whenever an interrupt is generated in the input GPIO. - Digi APIX I2C Sample + Digi APIX I2C Example -Sample application to access and manage I2C slaves using the Digi APIX library. -The application writes a page of an external EEPROM memory with random -data and then reads the data back to validate it (tested with 24FC1026). +Example application to access and manage I2C slaves using the Digi APIX library. +This application writes a page of an external EEPROM memory with random data. +Afterward, it reads the data back to validate it (tested with 24FC1026). apix-i2c-example @@ -46,12 +47,12 @@ data and then reads the data back to validate it (tested with 24FC1026). - Digi APIX PWM Sample + Digi APIX PWM Example -Sample application to access and manage PWM lines using the Digi APIX library. -The application enables one PWM line of the board using a frequency of -1000Hz. Then, progressively modifies the duty cycle in a loop from 10% to -90% and vice-versa. +Example application to access and manage PWM lines using the Digi APIX library. +This application enables one PWM line of the board using a frequency of 1000Hz. +Then, it progressively modifies the duty cycle in a loop from 10% to 90% and +vice-versa. apix-pwm-example @@ -62,13 +63,13 @@ The application enables one PWM line of the board using a frequency of - Digi APIX SPI Sample + Digi APIX SPI Example -Sample application to access and manage SPI slaves using the Digi APIX library. -The example application writes a page of an external EEPROM memory with random -data and then reads the data back to validate it. -Most of EEPROM memories are compatible with the sample specifying the page size and -the number of address bytes. +Example application to access and manage SPI slaves using the Digi APIX library. +This application writes a page of an external EEPROM memory with random data. +Afterward, it reads the data back to validate it. +Most EEPROM memories are compatible with the example. You only need to specify +the page size and the address size in bytes. apix-spi-example