|
1 | | -# Product Name |
| 1 | +# M5Unit - CRYPTO |
2 | 2 |
|
3 | 3 | ## Overview |
4 | 4 |
|
5 | | -### SKU:xxx |
| 5 | +Library for CRYPTO using [M5UnitUnified](https://github.com/m5stack/M5UnitUnified). |
| 6 | +M5UnitUnified is a library for unified handling of various M5 units products. |
6 | 7 |
|
7 | | -Description of the product |
| 8 | +### SKU:U124 |
8 | 9 |
|
9 | | -## Related Link |
| 10 | +Unit ID is an encryption coprocessor with hardware-based secure key storage, integrating the ATECC608B hardware encryption chip and using the I2C communication interface. The chip has a built-in 10Kb EEPROM, which can be used to store keys, certificates, data, consumption records, and security configurations. By restricting access policies to memory areas, the configuration can be locked to prevent changes. |
10 | 11 |
|
11 | | -- [Document & Datasheet](https://docs.m5stack.com/en/unit/product_Link) |
| 12 | +Supports the Trust&GO platform (pre-configured with universal certificates, suitable for TLS-based network security authentication, such as AWS-IoT, Azure, Google, and other cloud platform verification registrations). The internal certificate of the encryption chip can be directly obtained through tools to complete automatic registration without exposing the private key. |
12 | 13 |
|
13 | | -## Required Libraries: |
| 14 | +The pre-configured Trust&GO security element only supports the "Microchip Trust Platform". For more details, please refer to the following link. https://www.microchip.com/en-us/product/ATECC608B-TNGTLS |
14 | 15 |
|
15 | | -- [Adafruit_BMP280_Library](https://github.com/adafruit/Required_Libraries_Link) |
| 16 | +### SKU:K010-AWS |
16 | 17 |
|
17 | | -## License |
| 18 | +Core2 for AWS is a dedicated kit for AWS IoT learning projects. It consists of the M5Stack Core2 main control unit and the M5GO-Bottom For AWS expansion base, with an additional custom integration of the ATECC608 Trust&GO hardware encryption, making it an ideal kit for IoT learning and secure project development. |
18 | 19 |
|
19 | | -- [Product Name- MIT](LICENSE) |
20 | 20 |
|
21 | | -## Remaining steps(Editorial Staff Look,After following the steps, remember to delete all the content below) |
| 21 | +## Related Link |
| 22 | +See also examples using conventional methods here. |
22 | 23 |
|
23 | | -1. Change [clang format check path](./.github/workflows/clang-format-check.yml#L9-L15). |
24 | | -2. Add License content to [LICENSE](/LICENSE). |
25 | | -3. Change link on line 78 of [bug-report.yml](./.github/ISSUE_TEMPLATE/bug-report.yml#L78). |
| 24 | +- [Unit ID & Datasheet](https://docs.m5stack.com/en/unit/id) |
26 | 25 |
|
27 | | -```cpp |
28 | | -Example |
29 | | -# M5Unit-ENV |
| 26 | +### Required Libraries: |
| 27 | +- [M5UnitUnified](https://github.com/m5stack/M5UnitUnified) |
| 28 | +- [M5Utility](https://github.com/m5stack/M5Utility) |
| 29 | +- [M5HAL](https://github.com/m5stack/M5HAL) |
30 | 30 |
|
31 | | -## Overview |
| 31 | +## License |
32 | 32 |
|
33 | | -### SKU:U001 & U001-B & U001-C |
| 33 | +- [M5Unit-CRYPTO - MIT](LICENSE) |
34 | 34 |
|
35 | | -Contains M5Stack-**UNIT ENV** series related case programs.ENV is an environmental sensor with integrated SHT30 and QMP6988 internally to detect temperature, humidity, and atmospheric pressure data. |
| 35 | +## Examples |
| 36 | +See also [examples/UnitUnified](examples/UnitUnified) |
36 | 37 |
|
37 | | -## Related Link |
| 38 | +### Ported from Blinky-Hello-World (SKU:K010-AWS) |
| 39 | +See also [examples/UnitUnified/UnitID/Blinky-Hello-World](examples/UnitUnified/UnitID/Blinky-Hello-World) |
38 | 40 |
|
39 | | -- [Document & Datasheet](https://docs.m5stack.com/en/unit/envIII) |
40 | 41 |
|
41 | | -## Required Libraries: |
| 42 | +## Doxygen document |
| 43 | +[GitHub Pages](https://m5stack.github.io/M5Unit-CRYPTO/) |
42 | 44 |
|
43 | | -- [Adafruit_BMP280_Library](https://github.com/adafruit/Adafruit_BMP280_Library) |
| 45 | +If you want to generate documents on your local machine, execute the following command |
44 | 46 |
|
45 | | -## License |
| 47 | +``` |
| 48 | +bash docs/doxy.sh |
| 49 | +``` |
| 50 | + |
| 51 | +It will output it under docs/html |
| 52 | +If you want to output Git commit hashes to html, do it for the git cloned folder. |
| 53 | + |
| 54 | +### Required |
| 55 | +- [Doxyegn](https://www.doxygen.nl/) |
| 56 | +- [pcregrep](https://formulae.brew.sh/formula/pcre2) |
| 57 | +- [Git](https://git-scm.com/) (Output commit hash to html) |
46 | 58 |
|
47 | | -- [M5Unit-ENV - MIT](LICENSE) |
48 | | -``` |
|
0 commit comments