From f601f0e57060b6bdd3d6e0c257adbad3ded7aedc Mon Sep 17 00:00:00 2001 From: sundp Date: Sun, 5 Nov 2023 09:02:22 +0800 Subject: [PATCH] revised readme.md --- .gitignore | 108 +++++++++---------- README.md | 79 ++++++++++++-- STM32CubeIDE/.settings/language.settings.xml | 4 +- 3 files changed, 129 insertions(+), 62 deletions(-) diff --git a/.gitignore b/.gitignore index cd531cf..c848d7a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,54 +1,54 @@ -# ---> C -# Prerequisites -*.d - -# Object files -*.o -*.ko -*.obj -*.elf - -# Linker output -*.ilk -*.map -*.exp - -# Precompiled Headers -*.gch -*.pch - -# Libraries -*.lib -*.a -*.la -*.lo - -# Shared objects (inc. Windows DLLs) -*.dll -*.so -*.so.* -*.dylib - -# Executables -*.exe -*.out -*.app -*.i*86 -*.x86_64 -*.hex - -# Debug files -*.dSYM/ -*.su -*.idb -*.pdb - -# Kernel Module Compile Results -*.mod* -*.cmd -.tmp_versions/ -modules.order -Module.symvers -Mkfile.old -dkms.conf - +# ---> C +# Prerequisites +*.d + +# Object files +*.o +*.ko +*.obj +*.elf + +# Linker output +*.ilk +*.map +*.exp + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# Debug files +*.dSYM/ +*.su +*.idb +*.pdb + +# Kernel Module Compile Results +*.mod* +*.cmd +.tmp_versions/ +modules.order +Module.symvers +Mkfile.old +dkms.conf + diff --git a/README.md b/README.md index 0c161fc..9848b95 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,73 @@ -# STS_RR_R125 - -STS_R1 -STS_R2 -STS_R5 -For Jumbo Roll, Tissue Paper, Waste Bin sensor \ No newline at end of file +# STS_RR_R125 +/** + @page Yunhorn STS IOT Core Readme file + + @verbatim + + ****************************************************************************** + +* @file: Readme.txt STS_R1 STS_R2 STS_R5 * +* @author Yunhorn (r) Technology Limited Application Team * +* @brief Yunhorn (r) SmarToilets (r) Product configuration file. * + + ****************************************************************************** + +* @attention +* +* Copyright (c) 2023 Yunhorn Technology Limited. +* Copyright (c) 2023 Shenzhen Yunhorn Technology Co., Ltd. +* All rights reserved. +* +* This software is licensed under terms that can be found in the LICENSE file +* in the root directory of this software component. +* If no LICENSE file comes with this software, it is provided AS-IS. +* + + ****************************************************************************** + + @endverbatim + +Pre-defines + TOF_1 , U3, RIGHT SENSOR, XSHUT:PB-3, INT:PB-5 + TOF_2 , U4, LEFT SENSOR, XSHUT:PA-9,INT:PB-5 *** Default TOF ON BOARD + TOF_3 , P6,P7,P10 out interface, XSHUT:PA-10,INT:PB-5 + SOAP_LEVEL_SENSOR, Switch/XSHUT: PB-3, INPUT-STATUS: PA-10 + ROCTEC_R5, for upload payload format with distance only, 2 bytes + LED_ONBOARD, If LED soldered on board + +@par Description + + STS_R1 STS_R2 STS_R5 For + + | STS-R1 | Jumbo Roll Level | TOF VL53L0X | + | STS-R2 | Tissue Paper Level | TOF VL53L0X | + | STS-R5 | Waste Bin Level | TOF VL53L0X | + + # STS-R5 # Waste Bin Level RocTec | TOF VL53L0X | + + | STS-O2 | Presence Sensor | TOF VL53L1/L3 | + | STS-O3 | Presence Sensor | TOF VL53L1/L3 | + | STS-O4 | Urinal Occupy Sensor | TOF VL53L1/L3 | + | STS-O5 | Door Contact | GPIO ReedSwitch | + + | STS-R3 | Soap Dispenser Sensor | GPIO Capacitive | + | STS-R4 | Cistern/Tank Level Sensor | UART UltraSonic | + + | STS-M1 | Water Leakage Sensor | GPIO ReedSwitch | + | STS-M3 | Tank Level Sensor | UART UltraSonic | + | STS-M4 | Water Flow Sensor | TIM2_ETR counting, PA5 | + + + | STS-P1 | Queueing length Sensor | IW6843 | + | STS-P2 | Bi-Directional People Count | TOF VL53L1/L3 | + + | STS-M7 | Vibration Sensor | I2C 3-Axis vibration | + + + Jumbo Roll, Tissue Paper, Waste Bin sensor + + ****************************************************************************** + +@par Keywords + + */ diff --git a/STM32CubeIDE/.settings/language.settings.xml b/STM32CubeIDE/.settings/language.settings.xml index 0faf4e3..90dc1e6 100644 --- a/STM32CubeIDE/.settings/language.settings.xml +++ b/STM32CubeIDE/.settings/language.settings.xml @@ -5,7 +5,7 @@ - + @@ -16,7 +16,7 @@ - +