generated from m5stack/M5Template-C-CPP
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
5,179 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,12 +7,12 @@ jobs: | |
strategy: | ||
matrix: | ||
path: | ||
- check: './' # path to include | ||
exclude: '' # path to exclude | ||
# - check: 'src' | ||
# exclude: '(Fonts)' # Exclude file paths containing "Fonts" | ||
# - check: 'examples' | ||
# exclude: '' | ||
- check: 'src' | ||
exclude: '' | ||
- check: 'examples' | ||
exclude: '' | ||
- check: 'test' | ||
exclude: '' | ||
steps: | ||
- uses: actions/[email protected] | ||
- name: Run clang-format style check for C/C++/Protobuf programs. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,64 @@ | ||
# Product Name | ||
# M5Unit - METER | ||
|
||
## Overview | ||
|
||
### SKU:xxx | ||
Library for AMeter/VMeter by M5UnitUnified. | ||
|
||
Description of the product | ||
The M5UnitUnified version of the library is located under [src/unit](src/unit). | ||
M5UnitUnfied has a unified API and can control multiple units via PaHub, etc. | ||
|
||
## Related Link | ||
|
||
- [Document & Datasheet](https://docs.m5stack.com/en/unit/product_Link) | ||
### SKU:U086 & SKU:U087 | ||
|
||
## Required Libraries: | ||
Ameter(SKU:U086) Unit is a current meter that can monitor the current in real time. The 16-bit ADS1115 ADC (analog-to-digital) converter can be used to communicate through I2C protocol (By default the I2C address is 0X48 unless manually modified). | ||
|
||
- [Adafruit_BMP280_Library](https://github.com/adafruit/Required_Libraries_Link) | ||
In order to ensure the measurement accuracy, there is a built-in DC-DC isolated power supply. | ||
|
||
## License | ||
The I2C interface is also electrically isolated through the low-power isolator module CA-IS3020S, This prevents noise and surges on the data bus or other circuits from entering the local ground terminal to interfere or damage sensitive circuits. | ||
|
||
- [Product Name- MIT](LICENSE) | ||
Each Unit is factory calibrated with initial accuracy of 0.1%FS, ±1 count and resolution of 0.3mA. | ||
|
||
## Remaining steps(Editorial Staff Look,After following the steps, remember to delete all the content below) | ||
The unit has a maximum measurement current of ±4A, and an internal integrated 4A fuse to prevent excessive measurement current from burning out the circuit. | ||
|
||
1. Change [clang format check path](./.github/workflows/clang-format-check.yml#L9-L15). | ||
2. Add License content to [LICENSE](/LICENSE). | ||
3. Change link on line 78 of [bug-report.yml](./.github/ISSUE_TEMPLATE/bug-report.yml#L78). | ||
|
||
```cpp | ||
Example | ||
# M5Unit-ENV | ||
Voltmeter(SKU:U087) Unit is a voltage meter that can monitor the voltage in real time. The 16-bit ADC (analog-to-digital) converter ADS1115 is used internally to communicate through I2C (0X49). | ||
|
||
In order to ensure the measurement accuracy, there is a built-in DC-DC isolated power supply, and the I2C interface is also electrically isolated through the low-power isolator CA-IS3020S. | ||
|
||
This prevents noise and surges on the data bus or other circuits from entering the local ground terminal to interfere or damage sensitive circuits. Each Unit is individually calibrated when leaving the factory, initial accuracy of 0.1%FS, ±1 count, and a maximum measurement voltage of ±36V. | ||
|
||
|
||
## Overview | ||
|
||
### SKU:U001 & U001-B & U001-C | ||
|
||
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. | ||
|
||
## Related Link | ||
|
||
- [Document & Datasheet](https://docs.m5stack.com/en/unit/envIII) | ||
- [ADS1115t & Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/ADS1115.PDF) | ||
- [CA-IS3020S & Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/CA-IS3020S.pdf) | ||
|
||
## Required Libraries: | ||
|
||
- [Adafruit_BMP280_Library](https://github.com/adafruit/Adafruit_BMP280_Library) | ||
- [M5UnitUnified](https://github.com/m5stack/M5UnitUnified) | ||
- [M5Utility](https://github.com/m5stack/M5Utility) | ||
- [M5HAL](https://github.com/m5stack/M5HAL) | ||
|
||
## License | ||
|
||
- [M5Unit-ENV - MIT](LICENSE) | ||
``` | ||
- [M5Unit-METER- MIT](LICENSE) | ||
|
||
|
||
## Examples | ||
See also [examples/UnitUnified](examples/UnitUnified) | ||
|
||
## Doxygen document | ||
If you want to generate documents on your local machine, execute the following command | ||
|
||
``` | ||
bash docs/doxy.sh | ||
``` | ||
|
||
It will output it under docs/html | ||
|
||
### Required | ||
- [Doxyegn](https://www.doxygen.nl/) | ||
- [pcregrep](https://formulae.brew.sh/formula/pcre2) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
{ | ||
"build": { | ||
"core": "esp32", | ||
"extra_flags": [ | ||
"-DARDUINO_M5Stack_NanoC6" | ||
], | ||
"f_cpu": "160000000L", | ||
"f_flash": "80000000L", | ||
"flash_mode": "qio", | ||
"mcu": "esp32c6", | ||
"variant": "esp32c6" | ||
}, | ||
"connectivity": [ | ||
"wifi" | ||
], | ||
"debug": { | ||
"openocd_target": "esp32c6.cfg" | ||
}, | ||
"frameworks": [ | ||
"arduino", | ||
"espidf" | ||
], | ||
"name": "M5Stack NanoC6", | ||
"upload": { | ||
"flash_size": "4MB", | ||
"maximum_ram_size": 327680, | ||
"maximum_size": 4194384, | ||
"require_upload_port": true, | ||
"speed": 460800 | ||
}, | ||
"url": "https://docs.m5stack.com/en/core/M5NanoC6", | ||
"vendor": "M5Stack" | ||
} |
Oops, something went wrong.