Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for Issue 808: Door/Window sensor lost data after deep sleep #1176

Merged
merged 134 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
134 commits
Select commit Hold shift + click to select a range
c53fb57
Fix for Issue 808
bvelush Apr 10, 2024
8cd370f
minor typo fixes
bvelush Apr 11, 2024
c158499
fix network data log (#1175)
giedriuslt Apr 11, 2024
b61aea6
Add watchdog for LN882 (#1179)
giedriuslt Apr 13, 2024
aec5dfa
Fix index page performance for LN882H (#1180)
giedriuslt Apr 14, 2024
35b657e
Use ISO time everywhere (#1181)
giedriuslt Apr 15, 2024
7d8379d
Fix windows build
openshwprojects Apr 18, 2024
90808c1
Tokenizer_GetArgFloatDefault
openshwprojects Apr 18, 2024
e05484a
support dpID mult for TuyaMCU
openshwprojects Apr 18, 2024
05fb8db
add self test for TuyaMCU mult
openshwprojects Apr 18, 2024
7ebb7f8
fix incorrect naming (cosmetic change only)
openshwprojects Apr 18, 2024
1c2e199
update docs
openshwprojects Apr 18, 2024
f5e2a50
allow auto creation of tuya dpid storage
openshwprojects Apr 20, 2024
9b85615
add requestest flag for ac dir
openshwprojects Apr 21, 2024
8712741
Add AHT10/AHT2X/AHT30 I2C driver (#1187)
NonPIayerCharacter Apr 22, 2024
9234b5d
Update README.md
openshwprojects Apr 24, 2024
46e167b
Update README.md
openshwprojects Apr 24, 2024
63fac42
Update README.md
openshwprojects Apr 24, 2024
c283db2
Update README.md
openshwprojects Apr 24, 2024
e643b6e
Update README.md
openshwprojects Apr 24, 2024
b8417dd
Update README.md
openshwprojects Apr 24, 2024
ea6301b
Update README.md
openshwprojects Apr 24, 2024
1dbc8f4
Update README.md
openshwprojects Apr 24, 2024
9a46b31
Update README.md
openshwprojects Apr 24, 2024
f0a9a58
Update README.md
openshwprojects Apr 24, 2024
442a14e
Update README.md
openshwprojects Apr 24, 2024
b94351a
add self tests for addChangeHandler Power > 60 SetChannel 10 1234
openshwprojects Apr 26, 2024
54c42f0
Merge branch 'main' of https://github.com/openshwprojects/OpenBK7231T…
openshwprojects Apr 26, 2024
4cfd401
voltage change self tests
openshwprojects Apr 26, 2024
f1d1bb5
Update selftest_energyMeter.c
openshwprojects Apr 28, 2024
539e7c7
Update README.md
openshwprojects Apr 28, 2024
c32a026
Update README.md
openshwprojects Apr 28, 2024
ef2ef4a
allow SM16703P driver compilation on windows (self test stub)
openshwprojects Apr 28, 2024
7798e70
per pixel led self test base
openshwprojects Apr 28, 2024
d8a16a7
WS2812 stub for simulator
openshwprojects Apr 28, 2024
8a856b9
add reverse decoding of WS2812 pixels
openshwprojects Apr 28, 2024
d60876e
more ws self test
openshwprojects Apr 28, 2024
7aa735b
add a link between simulator and per pixel drv
openshwprojects Apr 28, 2024
d88385e
adding deduplication of similar messages
bvelush Apr 29, 2024
40e9f12
code cleanup
bvelush Apr 29, 2024
95e2ee4
Update OpenLN882H
openshwprojects Apr 29, 2024
951f768
LN882H enable or disable sleep mode while using a PowerSave (#1186)
MaxineMuster Apr 29, 2024
d1f7fcc
better pi9xel self test, fix DDP define
openshwprojects Apr 29, 2024
588a1cc
adding some comments, fixing typo
bvelush Apr 30, 2024
54dab32
declaring variables
bvelush Apr 30, 2024
9aabbd0
Set DNS hostname for ln882h (#1189)
giedriuslt Apr 30, 2024
d983502
pixelanim (#1192)
openshwprojects May 1, 2024
846a215
pwm freqq (#1203)
openshwprojects May 2, 2024
f2480fd
rename pwm freq command (#1204)
openshwprojects May 2, 2024
bbf502c
Update OpenLN882H
openshwprojects May 3, 2024
f2bedb2
silence messages on each spi send in drv_spidma.c
openshwprojects May 3, 2024
9257ebc
Update drv_pixelAnim.c
openshwprojects May 3, 2024
7be9bf6
hide CW bar fdr SM16703P
openshwprojects May 4, 2024
fb9b7a6
pixelanim speed p1, reorganize
openshwprojects May 4, 2024
b483a80
add shooting star
openshwprojects May 4, 2024
c960c1c
make LED basecolors public
openshwprojects May 4, 2024
70fc43b
add command to change LED anim
openshwprojects May 4, 2024
e4f84cb
spoeed cmd
openshwprojects May 4, 2024
7a0f731
Remove strftime to save space (#1210)
giedriuslt May 5, 2024
6138d65
Enable calendar events for bl602 (#1208)
giedriuslt May 5, 2024
726cf19
respect OBK_DISABLE_ALL_DRIVERS
openshwprojects May 5, 2024
19345af
fix typo pointed by Wolfieee
openshwprojects May 6, 2024
f5ab8bf
fix buffer for pixelanim
openshwprojects May 6, 2024
5238332
add pixe;lanim to prtoject
openshwprojects May 7, 2024
44b0d7c
add Motion channeltype
openshwprojects May 7, 2024
47c4f4e
self test for motion
openshwprojects May 7, 2024
2fcc44e
hass discovery test for illuminance
openshwprojects May 7, 2024
072cf56
try BL602 with ENABLE_EXPAND_CONSTANT 1 (#1212)
openshwprojects May 7, 2024
9be6418
add support for 7 segment driver HD2015E (#1214)
openshwprojects May 7, 2024
6d58d85
second fix for channel type priority
openshwprojects May 7, 2024
35beeaa
includfe HD2015 in prj
openshwprojects May 7, 2024
eee9311
Update drv_tm_gn_display_shared.c
openshwprojects May 7, 2024
d7a6381
Update drv_tm_gn_display_shared.c
openshwprojects May 7, 2024
a114bde
Update drv_tm_gn_display_shared.c
openshwprojects May 7, 2024
09359e2
cosmetic rename
openshwprojects May 7, 2024
dffe39c
Merge branch 'main' of https://github.com/openshwprojects/OpenBK7231T…
openshwprojects May 7, 2024
41f7e4c
Publish file (#1221)
openshwprojects May 9, 2024
32de473
fix HASS discovery with unusually long name
openshwprojects May 9, 2024
c525a00
add test for HASS discovery with unusually long name
openshwprojects May 9, 2024
e0bc56f
docs
openshwprojects May 10, 2024
ce4714d
docs
openshwprojects May 10, 2024
9e32046
Fix unknown method handling, lock on logging (#1224)
giedriuslt May 11, 2024
129f0c5
extend doorsensor DSTime command
openshwprojects May 11, 2024
29cba03
Merge branch 'main' of https://github.com/openshwprojects/OpenBK7231T…
openshwprojects May 11, 2024
0a1520b
add door sensor self test
openshwprojects May 11, 2024
9e71da2
a bit better docs
openshwprojects May 11, 2024
b8ec9de
docs
openshwprojects May 11, 2024
cc38adf
docs
openshwprojects May 11, 2024
ebc9467
some more docs work
openshwprojects May 11, 2024
b3db6df
optimized pins page? - part 1
openshwprojects May 11, 2024
8cad88a
filter
openshwprojects May 11, 2024
5dd30c6
pins page is now down to 8kb (was 90kb, then 10kb)
openshwprojects May 11, 2024
83d37b3
Implement LittleFS for LN882H - only first basic testing from WebApp …
MaxineMuster May 12, 2024
0dc9d5c
door sensor clear self test
openshwprojects May 12, 2024
1c221dc
allow bl602 to use constants in publishFloat ant similar (#1229)
giedriuslt May 12, 2024
ce52758
better door sensor clear self test
openshwprojects May 12, 2024
f2dd2b4
test command with spaces - ok?
openshwprojects May 12, 2024
6526cda
fix and selftest - backlog should not return non-zero value when comm…
openshwprojects May 12, 2024
03d6824
Stack size for BL is not enough to execute backlog commands (#1226)
giedriuslt May 12, 2024
99d0724
move more test commands to... cmd_test.c
openshwprojects May 12, 2024
65b9bd6
correct BMP280.c startdriver example, add bmp280.h detected flash ID …
divadiow May 13, 2024
6648537
extend pin cfg page: (#1228)
MaxineMuster May 13, 2024
4984ade
Update workflow.yaml
openshwprojects May 13, 2024
4174cf2
Update workflow.yaml
openshwprojects May 13, 2024
f487e4f
few more self tests for command backlog
openshwprojects May 13, 2024
19c5346
Update workflow.yaml (#1234)
DeDaMrAzR May 13, 2024
df7d9ab
Update workflow.yaml (#1235)
DeDaMrAzR May 13, 2024
db8fdda
Update workflow.yaml
openshwprojects May 13, 2024
c80dac1
negation method self test
openshwprojects May 13, 2024
7a7ad1e
Drawers (#1232)
openshwprojects May 14, 2024
c11a8d1
allow disabling Tasmota JSON API (#1236)
openshwprojects May 14, 2024
8e4f590
Update README.md
openshwprojects May 14, 2024
d409941
add smart LED drawers project information
openshwprojects May 14, 2024
5b737ca
Fix possible wrong index / shorten JS code (#1238)
MaxineMuster May 14, 2024
7947557
refresh docs
openshwprojects May 15, 2024
0db689b
reenable tasmota json on simulator
openshwprojects May 15, 2024
1060650
add a waitfor channel self test
openshwprojects May 15, 2024
a7de79a
add bInv to TuyaMCU
openshwprojects May 15, 2024
099c8e2
add bInv selftest
openshwprojects May 15, 2024
ecc224e
add mult self test for tuyamcu
openshwprojects May 16, 2024
3908f11
cosmetic change only - rename to dpID
openshwprojects May 16, 2024
e8e4d19
selftest vcp constants
openshwprojects May 17, 2024
a8afa67
self test - turn off script for a user - part 1
openshwprojects May 18, 2024
e609f37
Publish internal temperature to Home Assistant (#1243)
giedriuslt May 19, 2024
f850ccd
allow auto wake up of DoorSensor
openshwprojects May 20, 2024
0fe3299
Use functional define for constant expansion (#1244)
giedriuslt May 20, 2024
84f1176
Update README.md
openshwprojects May 21, 2024
c53144d
Fix for Issue 808
bvelush Apr 10, 2024
c4c38ef
minor typo fixes
bvelush Apr 11, 2024
0dab2f3
adding deduplication of similar messages
bvelush Apr 29, 2024
ea8376c
code cleanup
bvelush Apr 29, 2024
2b0b45b
adding some comments, fixing typo
bvelush Apr 30, 2024
56a79b7
typo fixes
bvelush May 24, 2024
d059f28
Merge branch 'issue_808' of https://github.com/bvelush/OpenBK7231T_Ap…
bvelush May 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .github/workflows/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ jobs:
new_release: ${{ steps.refs.outputs.new_release }}
steps:
- name: Source checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
submodules: recursive
- name: Update SDKs if required
run: make update-submodules
- name: Semantic Release
id: semantic
uses: cycjimmy/semantic-release-action@v3
uses: cycjimmy/semantic-release-action@v4
with:
dry_run: true
semantic_version: 19
semantic_version: 21
extra_plugins: |
@semantic-release/changelog
@semantic-release/git
conventional-changelog-conventionalcommits
conventional-changelog-conventionalcommits@7
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Set outputs
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
platform: [OpenBK7231T, OpenBK7231N, OpenXR809, OpenBL602, OpenW800, OpenW600, OpenLN882H]
steps:
- name: Source checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
submodules: recursive
- uses: actions/setup-python@v2
Expand All @@ -88,7 +88,7 @@ jobs:
- name: Run make
run: make APP_VERSION=${{ needs.refs.outputs.version }} APP_NAME=${{ matrix.platform }} ${{ matrix.platform }}
- name: Save build assets
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v3
with:
name: ${{ env.APP_NAME }}_${{ needs.refs.outputs.version }}
path: |
Expand All @@ -115,22 +115,22 @@ jobs:
if: always() && needs.refs.outputs.new_release == 'true' && (github.ref == 'refs/heads/main' || github.ref_name == 'alpha')
steps:
- name: Source checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Fetch build assets
uses: actions/download-artifact@v2
uses: actions/download-artifact@v3
with:
name: ${{ env.APP_NAME }}_${{ needs.refs.outputs.version }}
path: output/${{ needs.refs.outputs.version }}
- name: Run Semantic Release
id: semantic
uses: cycjimmy/semantic-release-action@v3
uses: cycjimmy/semantic-release-action@v4
with:
dry_run: false
semantic_version: 19
semantic_version: 21
extra_plugins: |
@semantic-release/changelog
@semantic-release/git
conventional-changelog-conventionalcommits
conventional-changelog-conventionalcommits@7
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Echo Semantic Release Versions
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,23 @@ OpenBK7231T/OpenBeken is a Tasmota/Esphome replacement for new Tuya modules feat
This repository is named "OpenBK7231T_App", but now it's a multiplatform app, supporting build for multiple separate chips:
- [BK7231T](https://www.elektroda.com/rtvforum/topic3951016.html) ([WB3S](https://developer.tuya.com/en/docs/iot/wb3s-module-datasheet?id=K9dx20n6hz5n4), [WB2S](https://developer.tuya.com/en/docs/iot/wb2s-module-datasheet?id=K9ghecl7kc479), WB2L, etc)
- [BK7231N](https://www.elektroda.com/rtvforum/topic3951016.html) ([CB2S](https://developer.tuya.com/en/docs/iot/cb2s-module-datasheet?id=Kafgfsa2aaypq), [CB2L](https://developer.tuya.com/en/docs/iot/cb2l-module-datasheet?id=Kai2eku1m3pyl), [WB2L_M1](https://www.elektroda.com/rtvforum/topic3903356.html), etc)
- T34 ([T34 is based on BK7231N](https://developer.tuya.com/en/docs/iot/t34-module-datasheet?id=Ka0l4h5zvg6j8))
- T34 ([T34 is based on BK7231N](https://developer.tuya.com/en/docs/iot/t34-module-datasheet?id=Ka0l4h5zvg6j8)), see [flashing trick](https://www.elektroda.com/rtvforum/topic4036975.html)
- BL2028N ([BL2028N is a Belon version of BK7231N](https://www.elektroda.com/rtvforum/viewtopic.php?p=20262533#20262533))
- [XR809](https://www.elektroda.com/rtvforum/topic3806769.html) ([XR3](https://developer.tuya.com/en/docs/iot/xr3-datasheet?id=K98s9168qi49g), etc)
- [BL602](https://www.elektroda.com/rtvforum/topic3889041.html) ([SM-028_V1.3 etc](https://www.elektroda.com/rtvforum/topic3945435.html))
- [BL602](https://www.elektroda.com/rtvforum/topic3889041.html) ([SM-028_V1.3 etc](https://www.elektroda.com/rtvforum/topic3945435.html)), see also [BL602 flash OBK via OTA tutorial](https://www.elektroda.com/rtvforum/topic4050297.html)
- [LF686](https://www.leapfive.com/wp-content/uploads/2020/09/LF686-Datasheet.pdf) (flash it [as BL602](https://www.elektroda.com/rtvforum/topic4024917.html))
- W800 (W800-C400, WinnerMicro WiFi & Bluetooth), W801
- [W600](https://www.elektroda.com/rtvforum/viewtopic.php?p=20252619#20252619) (WinnerMicro chip), W601 ([WIS600, ESP-01W](https://www.elektroda.com/rtvforum/topic3950611.html), [TW-02](https://www.elektroda.com/rtvforum/viewtopic.php?p=20239610#20239610), [TW-03](https://www.elektroda.com/rtvforum/topic3929601.html), etc)
- [LN882H](https://www.elektroda.com/rtvforum/topic4027545.html) WIP platform, see [sample device teardown and flashing](https://www.elektroda.com/rtvforum/topic4032240.html)
- [LN882H](https://www.elektroda.com/rtvforum/topic4027545.html) by Lightning Semi - [datasheet](https://www.elektroda.com/rtvforum/topic4027545.html), see [flashing how-to](https://www.elektroda.com/rtvforum/topic4028087.html), see [sample device teardown and flashing](https://www.elektroda.com/rtvforum/topic4032240.html), see [new flash tool](https://www.elektroda.com/rtvforum/topic4045532.html), see [dev board](https://www.elektroda.com/rtvforum/topic4050274.html)
- Windows, via [simulator](https://www.elektroda.com/rtvforum/topic4046056.html)

Please use automatically compiled binaries from the Releases tab. To build yourself for a given platform, just checkout first our version of SDK and then checkout this app repository into it, details later.

See our guides in Russian: [BK7231N/T34](https://www.v-elite.ru/t34), and [BL602 RGB](https://www.v-elite.ru/bl602rgb), and [Youtube guide for BK7231/T34](https://www.youtube.com/watch?v=BnmSWZchK-E)

If you want to get some generic information about BK7231 modules, available datasheets, pinout, peripherals, [consult our docs topic](https://www.elektroda.com/rtvforum/topic3951016.html).


# [Supported Devices/Templates List](https://openbekeniot.github.io/webapp/devicesList.html) Now with 500+ entries! (Get 🏆[free SD Card](https://www.elektroda.com/rtvforum/topic3950844.html)🏆 for submitting new one!)
We have our own interactive devices database that is maintained by users.
The database is also accessible from inside our firmware (but requires internet connection to fetch).
Expand All @@ -36,18 +38,18 @@ You can help us by giving like, a comment and subscribe!

OpenBeken features:
- Tasmota-like setup, configuration and experience on all supported platforms (supports [common Tasmota JSON over http](https://www.youtube.com/watch?v=OhdkEJ-SuTU) and MQTT, etc)
- OTA firmware upgrade system (for BK, W*00, BL602); to use OTA, [drag and drop](https://www.youtube.com/watch?v=OPcppowaxaA) proper OTA file on OTA field on new Web App Javascript Console
- Online [builds for all platforms](https://github.com/openshwprojects/OpenBK7231T_App/releases) via Github, also supports [Docker builds](https://github.com/openshwprojects/OpenBK7231T_App/tree/main/docker)
- OTA firmware upgrade system (for BK, W*00, BL602, LN); to use OTA, [drag and drop](https://www.youtube.com/watch?v=OPcppowaxaA) proper OTA file on OTA field on new Web App Javascript Console
- Online [builds for all platforms](https://github.com/openshwprojects/OpenBK7231T_App/releases) via Github, configurable [per-user build system](https://www.elektroda.com/rtvforum/topic4033833.html), also supports [Docker builds](https://github.com/openshwprojects/OpenBK7231T_App/tree/main/docker)
- MQTT compatibility with Home Assistant (with both Yaml generator and [HA Discovery](https://youtu.be/pkcspey25V4))
- Support for multiple relays, buttons, leds, inputs and PWMs, everything fully scriptable
- [Driver system](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/drivers.md) for custom peripherals, including [TuyaMCU](https://www.elektroda.com/rtvforum/topic4038151.html) (see [Dimmer tutorial](https://www.elektroda.com/rtvforum/topic3898502.html)), I2C bus and [BL0942](https://www.elektroda.com/rtvforum/topic3887748.html), BL0937 power metering chips, Motor Driver Bridge.
- Hardware and software I2C, supports multiple I2C devices, like TC74 temperature sensor, MCP23017 port expander, PCF8574T LCD 2x16 (or other?), etc
- Hardware and software SPI, support for SPI BL0942, etc
- NTP time from network (can be used with [TH06](https://www.elektroda.com/rtvforum/topic3942730.html) and other TuyaMCU devices), can run any script on selected weekday hour:minute:second
- Dedicated [TuyaMCU support](https://www.elektroda.com/rtvforum/topic4038151.html) with extra TuyaMCU analyzer tool for decoding new devices ([tutorial here](https://www.elektroda.com/rtvforum/topic3970199.html), code [repository here](https://github.com/openshwprojects/TuyaMCUAnalyzer))
- support for [TuyaMCU Battery Powered devices protocol](https://www.elektroda.com/rtvforum/topic3914412.html) (TuyaMCU enables WiFi module only to report the state, eg. for door sensors, water sensors)
- Dedicated TuyaMCU analyzer tool for decoding new devices ([tutorial here](https://www.elektroda.com/rtvforum/topic3970199.html), code [repository here](https://github.com/openshwprojects/TuyaMCUAnalyzer))
- [RGBCW LED lighting control](https://www.youtube.com/watch?v=YQdR7r6lXRY) compatible with Home Assistant (including PWM LEDs, and SM2135, BP5758, etc )
- LittleFS integration for scripts and large files (you can [write scripts there](https://www.youtube.com/watch?v=kXi8S12tmC8), you can host a page there with REST interface control of device)
- LittleFS integration for scripts and large files (you can [write scripts there](https://www.youtube.com/watch?v=kXi8S12tmC8), you can host a page there with [REST interface control](https://www.elektroda.com/rtvforum/topic3971355.html) of device)
- Command line system for starting and configuring drivers, for controlling channels, etc
- Short startup command (up to 512 characters) storage in flash config, so you can easily init your drivers (eg. BL0942) without LittleFS
- Advanced scripting and events system (allows you to mirror Tasmota rules, for example catch button click, double click, hold)
Expand All @@ -60,7 +62,9 @@ OpenBeken features:
- Supports automatic GPIO setup with [Tuya GPIO extraction](https://www.youtube.com/watch?v=WunlqIMAdgw), [cloudcutter templates](https://www.elektroda.com/rtvforum/topic3973669.html), can also import/export [OpenBeken templates](https://openbekeniot.github.io/webapp/devicesList.html), you can also use [GPIODoctor to find out quickly GPIO roles](https://www.elektroda.com/rtvforum/topic3976371.html)
- Advanced and custom drivers like [synchronized PWM groups with configurable dead time](https://www.elektroda.com/rtvforum/topic4025665.html)
- WS2812B support, see [scripting tutorial](https://www.elektroda.com/rtvforum/topic4036716.html)
- LFS and REST API allows you to create and host a custom HTML+CSS+JS page on device with a custom GUI/display of channels/TuyaMCU dpIDs, see [tutorial](https://www.elektroda.com/rtvforum/topic3971355.html) and see [sample page](https://www.elektroda.com/rtvforum/viewtopic.php?p=20932186#20932186)
- LFS and REST API allows you to create and host a custom HTML+CSS+JS page on device with a custom GUI/display of channels/TuyaMCU dpIDs, see [tutorial](https://www.elektroda.com/rtvforum/topic3971355.html) and see [sample page](https://www.elektroda.com/rtvforum/viewtopic.php?p=20932186#20932186) , and see [final version of custom TOMPD-63-WIFI page](https://www.elektroda.com/rtvforum/topic4040354.html)
- can control 'smart lab organiser drawers' with a custom Drawers driver, see [full presentation](https://www.elektroda.com/rtvforum/topic4054134.html)
- Can run on Windows with device simulator/schematic drawer, see [tutorial](https://www.elektroda.com/rtvforum/topic4046056.html)
- and much more

There is also a bit more outdated [WIKI](https://github.com/openshwprojects/OpenBK7231T_App/wiki/Wiki-Home)
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Do not add anything here, as it will overwritten with next rebuild.
| Section | Comment |
|:------------- |------:|
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (79 total) | You can set pin roles in 'Configure Module' section or use one of predefined templates in Web App. For each pin, you also set corresponding channel value. This is needed for modules with multiple relays. If you have 3 relays and 3 buttons, you need to use channel values like 1, 2, and 3. Just enter '1' in the text field, etc. |
| [Flags](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/flags.md) (47 total) | Flags are global and allows you to alter behaviour of the device. |
| [Drivers](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/drivers.md) (47 total) | Drivers allows you to control certain peripherals or enable certain features that are off by default. |
| [Flags](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/flags.md) (49 total) | Flags are global and allows you to alter behaviour of the device. |
| [Drivers](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/drivers.md) (52 total) | Drivers allows you to control certain peripherals or enable certain features that are off by default. |
| [Script constants](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/constants.md) (38 total) | Every console command that takes an integer argument supports certain constant expansion. |
| [Channel Types](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md) (51 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' suffixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
| [Channel Types](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md) (52 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' suffixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
| [FAQ](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/faq.md) (31 total) | Here is a detailed list of questions you may ask. Some information from docs is repeated here. |
| [Console/Script commands](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands.md) (290 total) | There are multiple console commands that allow you to automate your devices. Commands can be entered manually in command line, can be send by HTTP (just like in Tasmota), can be send by MQTT and also can be scripted. |
| [Console/Script commands](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands.md) (299 total) | There are multiple console commands that allow you to automate your devices. Commands can be entered manually in command line, can be send by HTTP (just like in Tasmota), can be send by MQTT and also can be scripted. |
| [Command Examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commandExamples.md) (10 total) | Here you can find some examples of console commands usage |
| [Autoexec.bat examples (configs)](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/autoexecExamples.md) (34 total) | Here you can find examples of autoexec.bat configs. The autoexec.bat file can be created in Web Application, under LittleFS tab, and is run every time device reboots (unless device enters safe mode/AP mode). The autoexec.bat file allows you to create more advanced configs, setup TuyaMCU mappings, etc |
| [MQTT Topics](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/mqttTopics.md) (25 total) | MQTT topic names and content for incoming and outgoing OBK MQTT publishes |
| [Script examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/scriptExamples.md) (6 total) | Scripts can be put in autoexec.bat and then they will start automatically on reboot, you can also put script in other LittleFS file and use startScript [fileName] [Label] command to run them. From the firmware point of view, scripts and autoexecs are basically the same thing. There is, however, a little bit more advanced system of execution for scripts which can be written in a form of scripts threads that run over time, can have delays within then, conditional checks and jumps. |
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (290 total) | More details on commands. |
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (299 total) | More details on commands. |
1 change: 1 addition & 0 deletions docs/channelTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ Do not add anything here, as it will overwritten with next rebuild.
| Temperature_div100 | Just like humidity_div100, but for temperature. |
| LeakageCurrent_div1000 | . |
| Power_div100 | Just like power, but with one decimal place (but stored as integer, for TuyaMCU support) |
| Motion | Motion |
| Max | This is the current total number of available channel types. |
Loading
Loading