README.md: standarize prompts
Use the same prompts that we use in the online documentation: * For the target: "~#" * For the host: "~$" Signed-off-by: Jose Diaz de Grenu <Jose.DiazdeGrenu@digi.com>
This commit is contained in:
Jose Diaz de Grenu
parent
9286799d5c
commit
a821bc2f7c
|
|
@ -19,7 +19,7 @@ Running the application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-adc-example
|
||||
~# ./apix-adc-example
|
||||
Example application using libdigiapix ADC support
|
||||
|
||||
Usage: apix-adc-example <adc_chip> <adc_channel> <interval> <number_of_samples>
|
||||
|
|
@ -44,8 +44,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ Running the apix-can-recv-example application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-can-recv-example
|
||||
~# ./apix-can-recv-example
|
||||
Example application using libdigiapix CAN support"
|
||||
Usage: %s -i <can-iface> -b <bitrate> [options]"
|
||||
-i <can-iface> Name of the CAN interface"
|
||||
|
|
@ -90,7 +90,7 @@ If no arguments are provided, the example will use the default values:
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-can-send-example
|
||||
~# ./apix-can-send-example
|
||||
Example application using libdigiapix CAN support"
|
||||
"Usage: %s -i <can-iface> -b <bitrate> [options]"
|
||||
"-i <can-iface> Name of the CAN interface"
|
||||
|
|
@ -124,8 +124,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Running the application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-gpio-example
|
||||
~# ./apix-gpio-example
|
||||
Example application using libdigiapix GPIO support
|
||||
|
||||
Usage: apix-gpio-example <gpio_in> <gpio_out>
|
||||
|
|
@ -54,8 +54,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-neon-dey-linux-gnueabi
|
||||
$ make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Running the application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-i2c-example
|
||||
~# ./apix-i2c-example
|
||||
Example application using libdigiapix I2C support
|
||||
|
||||
Usage: apix-i2c-example <i2c-bus> <i2c-address> <address-size> <page-size> <page-index>
|
||||
|
|
@ -67,8 +67,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ Running the application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-pwm-example
|
||||
~# ./apix-pwm-example
|
||||
Example application using libdigiapix PWM support
|
||||
|
||||
Usage: apix-pwm-example <pwm-chip> <pwm-freq>
|
||||
|
|
@ -43,8 +43,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -59,13 +59,13 @@ Before launching the application, you must enable the SPI module with the
|
|||
following command:
|
||||
|
||||
```
|
||||
# modprobe spidev
|
||||
~# modprobe spidev
|
||||
```
|
||||
|
||||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-spi-example
|
||||
~# ./apix-spi-example
|
||||
Example application using libdigiapix SPI support
|
||||
|
||||
Usage: apix-spi-example <spi-dev> <spi-ss> <address-size> <page-size> <page-index>
|
||||
|
|
@ -89,8 +89,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-neon-dey-linux-gnueabi
|
||||
$ make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Running the application
|
|||
Once the binary is in the target, launch the application:
|
||||
|
||||
```
|
||||
# ./apix-watchdog-example
|
||||
~# ./apix-watchdog-example
|
||||
Example application using libdigiapix Watchdog support
|
||||
|
||||
Usage: apix-watchdog-example <watchdog_device> <timeout> <test_time>
|
||||
|
|
@ -33,8 +33,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -39,11 +39,11 @@ Running the application
|
|||
-----------------------
|
||||
Once the settings are properly configured, launch the application:
|
||||
```
|
||||
#> awsiot-sample
|
||||
~# awsiot-sample
|
||||
```
|
||||
You can specify the configuration file with `-c`:
|
||||
```
|
||||
#> awsiot-sample -c <absolute_path_to_configuration_file>
|
||||
~# awsiot-sample -c <absolute_path_to_configuration_file>
|
||||
```
|
||||
* The application reports its status to the topic
|
||||
`$aws/things/<thing_name>/shadow/update`. Something similar to:
|
||||
|
|
@ -89,8 +89,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -22,16 +22,16 @@ Running the application
|
|||
The following example shows how to encrypt and decrypt and file in place:
|
||||
|
||||
```
|
||||
# echo "Test file" > test.txt
|
||||
# caam-blob-example -e test.txt
|
||||
# hexdump -C test.txt
|
||||
~# echo "Test file" > test.txt
|
||||
~# caam-blob-example -e test.txt
|
||||
~# hexdump -C test.txt
|
||||
00000000 01 ee 30 e3 31 6b 72 94 94 06 62 e2 ef 17 4e 05 |..0.1kr...b...N.|
|
||||
00000010 34 c3 7b 96 58 35 ad b7 a2 89 b6 bc eb eb 81 39 |4.{.X5.........9|
|
||||
00000020 3c b2 e7 d7 2d 93 7d ff 8b a8 80 bd 55 e9 70 cf |<...-.}.....U.p.|
|
||||
00000030 20 51 9f 15 9e c5 aa 68 b3 90 | Q.....h..|
|
||||
0000003a
|
||||
# caam-blob-example -d test.txt
|
||||
# hexdump -C test.txt
|
||||
~# caam-blob-example -d test.txt
|
||||
~# hexdump -C test.txt
|
||||
00000000 54 65 73 74 20 66 69 6c 65 0a |Test file.|
|
||||
0000000a
|
||||
```
|
||||
|
|
@ -41,12 +41,12 @@ The key modifier is a 16 byte value encoded as 32 hexadecimal characters.
|
|||
If you want to write the CAAM blob to a different file, add another positional argument.
|
||||
|
||||
```
|
||||
# caam-blob-example -e -m ff0102030405060708090a0b0c0d0e0f test.txt encrypted.bin
|
||||
# caam-blob-example -d encrypted.bin decrypted.txt
|
||||
~# caam-blob-example -e -m ff0102030405060708090a0b0c0d0e0f test.txt encrypted.bin
|
||||
~# caam-blob-example -d encrypted.bin decrypted.txt
|
||||
[ERROR] could not decrypt data.
|
||||
[ERROR] Decryption failed
|
||||
# caam-blob-example -d -m ff0102030405060708090a0b0c0d0e0f encrypted.bin decrypted.txt
|
||||
# cat decrypted.txt
|
||||
~# caam-blob-example -d -m ff0102030405060708090a0b0c0d0e0f encrypted.bin decrypted.txt
|
||||
~# cat decrypted.txt
|
||||
Test file
|
||||
```
|
||||
|
||||
|
|
@ -57,8 +57,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ standard random number generator, like /dev/random.
|
|||
For example, you can get hexdump to display a random sample on the standard
|
||||
output:
|
||||
```
|
||||
root@ccimx6ulstarter:~# ./cryptochip-gen-random | hexdump
|
||||
~# ./cryptochip-gen-random | hexdump
|
||||
0000000 6239 ddd4 b378 693f 14ed bfa1 447b cff1
|
||||
0000010 275e fd14 e392 2b4a c2ff ac93 0f5e cbab
|
||||
0000020 16c1 e6b7 a458 c5ea c96f 59c9 776a 41c5
|
||||
|
|
@ -37,13 +37,13 @@ root@ccimx6ulstarter:~# ./cryptochip-gen-random | hexdump
|
|||
|
||||
You can also save the random data to a random file for later analysis:
|
||||
```
|
||||
root@ccimx6ulstarter:~# ./cryptochip-gen-random | pv --rate > data.bin
|
||||
~# ./cryptochip-gen-random | pv --rate > data.bin
|
||||
[ 912 B/s]
|
||||
```
|
||||
|
||||
And then run an entropy test:
|
||||
```
|
||||
root@ccimx6ulstarter:~# ent data.bin
|
||||
~# ent data.bin
|
||||
Entropy = 7.998261 bits per byte.
|
||||
|
||||
Optimum compression would reduce the size
|
||||
|
|
@ -64,8 +64,8 @@ sure to source the corresponding toolchain of the platform you are using,
|
|||
for example, for ConnectCore 6UL:
|
||||
|
||||
```
|
||||
$> . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
$> make
|
||||
~$ . <DEY-toolchain-path>/environment-setup-cortexa7hf-vfp-neon-dey-linux-gnueabi
|
||||
~$ make
|
||||
```
|
||||
|
||||
For more information, see the [Digi Embedded Yocto online documentation](https://github.com/digi-embedded/meta-digi).
|
||||
|
|
|
|||
Loading…
Reference in New Issue