apix readme: minor fixes for apix samples readme files
This commit: * adds the name of the connector in the readme files * uses the official platform names * minor changes for consistency between readme files Signed-off-by: Tatiana Leon <tatiana.leon@digi.com>
This commit is contained in:
Tatiana Leon
parent
029dcf0463
commit
9cf9701082
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 <i2c-bus> <i2c-address> <address-size> <page-size> <page
|
|||
Aliases for I2C 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
|
||||
|
|
@ -76,4 +76,4 @@ FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
||||
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
|
||||
THIS SOFTWARE.
|
||||
THIS SOFTWARE.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
Digi APIX PWM Sample Application
|
||||
Digi APIX PWM Example Application
|
||||
===================================
|
||||
|
||||
Sample application to access and manage PWM lines using the Digi APIX library.
|
||||
Example 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.
|
||||
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.
|
||||
|
||||
The PWM lines used in the sample are mapped as follows in the Digi Boards:
|
||||
- **CCIMX6 SBC**: PWM1 - Pin **10** of the parallel video (LCD) connector.
|
||||
- **CCIMX6Plus SBC**: PWM1 - Pin **10** of the parallel video (LCD) connector.
|
||||
- **CCIMX6UL SBC Express**: PWM1 - Pin **27** of the expansion connector.
|
||||
- **CCIMX6UL SBC Pro**: PWM4 - Pin **11** of the GPIO connector.
|
||||
The PWM lines used in this example are mapped as follows in the Digi boards:
|
||||
- **ConnectCore 6 SBC**: PWM1 - Pin **10** of the parallel video (LCD) connector (J21).
|
||||
- **ConnectCore 6 Plus SBC**: PWM1 - Pin **10** of the parallel video (LCD) connector (J21).
|
||||
- **ConnectCore 6UL SBC Express**: PWM1 - Pin **27** of the expansion connector (J8).
|
||||
- **ConnectCore 6UL SBC Pro**: PWM4 - Pin **11** of the GPIO connector (J30).
|
||||
|
||||
Running the application
|
||||
-----------------------
|
||||
|
|
@ -31,7 +31,7 @@ Aliases for PWM 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
|
||||
|
|
@ -60,4 +60,4 @@ FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
||||
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
|
||||
THIS SOFTWARE.
|
||||
THIS SOFTWARE.
|
||||
|
|
|
|||
|
|
@ -1,34 +1,37 @@
|
|||
Digi APIX SPI Example Application
|
||||
==================================
|
||||
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.
|
||||
|
||||
The SPI connections for the sample depends on the running platform:
|
||||
- **CCIMX6 SBC**: SPI connector of the board.
|
||||
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.
|
||||
|
||||
The SPI connections for this example depends on the running platform:
|
||||
- **ConnectCore 6 SBC**: SPI connector of the board (J34).
|
||||
- VCC: Pin 1
|
||||
- GND: Pin 8
|
||||
- SPI-1 CLK: Pin 2
|
||||
- SPI-1 MISO: Pin 3
|
||||
- SPI-1 MOSI: Pin 4
|
||||
- SPI-1 SS0: Pin 5
|
||||
- **CCIMX6Plus SBC**: SPI connector of the board.
|
||||
- **ConnectCore 6 Plus SBC**: SPI connector of the board (J34).
|
||||
- VCC: Pin 1
|
||||
- GND: Pin 8
|
||||
- SPI-1 CLK: Pin 2
|
||||
- SPI-1 MISO: Pin 3
|
||||
- SPI-1 MOSI: Pin 4
|
||||
- SPI-1 SS0: Pin 5
|
||||
- **CCIMX6UL SBC Express**: Expansion connector of the board.
|
||||
- **ConnectCore 6UL SBC Express**: Expansion connector of the board (J8).
|
||||
- VCC: Pin 17
|
||||
- GND: Pin 20
|
||||
- SPI-3 CLK: Pin 23
|
||||
- SPI-3 MISO: Pin 21
|
||||
- SPI-3 MOSI: Pin 19
|
||||
- SPI-3 SS0: Pin 24
|
||||
- **CCIMX6UL SBC Pro**: SPI connector of the board.
|
||||
- **ConnectCore 6UL SBC Pro**: SPI connector of the board (J34).
|
||||
- VCC: Pin 1
|
||||
- GND: Pin 8
|
||||
- SPI-1 CLK: Pin 2
|
||||
|
|
@ -38,13 +41,14 @@ The SPI connections for the sample depends on the running platform:
|
|||
|
||||
Running the application
|
||||
-----------------------
|
||||
Before launching the application you need to enable the SPI module with the
|
||||
Before launching the application, you must enable the SPI module with the
|
||||
following command:
|
||||
|
||||
```
|
||||
# modprobe spidev
|
||||
```
|
||||
Once the binary is in the target,launch the application:
|
||||
|
||||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-spi-example
|
||||
|
|
@ -61,7 +65,7 @@ Usage: apix-spi-example <spi-dev> <spi-ss> <address-size> <page-size> <page-inde
|
|||
Aliases for SPI 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
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<samples>
|
||||
<sample id="apix-adc-sample">
|
||||
<name>Digi APIX ADC Sample</name>
|
||||
<name>Digi APIX ADC Example</name>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<path>apix-adc-example</path>
|
||||
<platforms>
|
||||
|
|
@ -15,10 +16,10 @@ The application enables one ADC channel on the board. After that, the applicatio
|
|||
</platforms>
|
||||
</sample>
|
||||
<sample id="apix-gpio-sample">
|
||||
<name>Digi APIX GPIO Sample</name>
|
||||
<name>Digi APIX GPIO Example</name>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
|
|
@ -31,11 +32,11 @@ whenever an interrupt is generated in the input GPIO.
|
|||
</platforms>
|
||||
</sample>
|
||||
<sample id="apix-i2c-sample">
|
||||
<name>Digi APIX I2C Sample</name>
|
||||
<name>Digi APIX I2C Example</name>
|
||||
<description>
|
||||
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).
|
||||
</description>
|
||||
<path>apix-i2c-example</path>
|
||||
<platforms>
|
||||
|
|
@ -46,12 +47,12 @@ data and then reads the data back to validate it (tested with 24FC1026).
|
|||
</platforms>
|
||||
</sample>
|
||||
<sample id="apix-pwm-sample">
|
||||
<name>Digi APIX PWM Sample</name>
|
||||
<name>Digi APIX PWM Example</name>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<path>apix-pwm-example</path>
|
||||
<platforms>
|
||||
|
|
@ -62,13 +63,13 @@ The application enables one PWM line of the board using a frequency of
|
|||
</platforms>
|
||||
</sample>
|
||||
<sample id="apix-spi-sample">
|
||||
<name>Digi APIX SPI Sample</name>
|
||||
<name>Digi APIX SPI Example</name>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<path>apix-spi-example</path>
|
||||
<platforms>
|
||||
|
|
|
|||
Loading…
Reference in New Issue