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

Docs update for exposing scenes and setting scene name #933

Merged
merged 1 commit into from
Oct 8, 2021

Conversation

Koenkk
Copy link
Owner

@Koenkk Koenkk commented Oct 7, 2021

@Koenkk Koenkk mentioned this pull request Oct 7, 2021
3 tasks
@@ -9,6 +9,7 @@ Scenes can be created in two ways, by storing the current state (`scene_store`)

### `scene_store`
This is the easiest way to create a scene. First set the device or group in the desired state. Next store the current state as a scene by sending a command to `zigbee2mqtt/[GROUP_OR_DEVICE_FRIENDLY_NAME]/set` with payload `{"scene_store": SCENE_ID}` where `SCENE_ID` is a number (e.g. `1`).
To also provide a name for the scene (shown in e.g. the frontend) send e.g. `{"scene_store": {"ID": 1, "name": "My scene"}}`.
Copy link
Sponsor Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this name only use for the frontend? As there is also a scenename attribute in the ZCL so if the same constraint is used it can probably be written to the device as wel! (and retrieved if that ever gets implemented)

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it will be used in the frontend, @nurikk just added it.

I know scene names can be written to a device, however I don't see the benefit of it and I don't know if all devices support this.

@Koenkk Koenkk merged commit 79ce737 into develop Oct 8, 2021
@Koenkk Koenkk deleted the feature/scenes branch October 8, 2021 14:18
@sjorge
Copy link
Sponsor Contributor

sjorge commented Oct 8, 2021 via email

Koenkk added a commit that referenced this pull request Oct 31, 2021
* Update user extension.

* Availability refactor  (#707)

* Availability refactor proposal. Koenkk/zigbee2mqtt#6281

* Update availability docs.

* Update availability

* Update docs

* Added TuYa TS011F_plug_3 (#931)

* Added TuYa TS011F_plug_3

* Update TS011F_plug_3.md

* Docs update for exposing scenes and setting scene name. Koenkk/zigbee2mqtt#9056 (#933)

* Add doc for options expose. Koenkk/zigbee2mqtt#9110

* added MIR-HE200-TY (#943)

* TuYa Human Radar Motion-presence Sensor

Additional Konverter-Update is comming up

* Create MIR-HE200-TY.md

New TuYa Human Radar Sensor

* Update MIR-HE200-TY.md

including picture as *.jpg

* Update MIR-HE200-TY.md

picture will pushed seperately

* Picture for MIR-HE200-TY as jpg

* Delete MIR-HE200-TY.png

Co-authored-by: Koen Kanters <koenkanters94@gmail.com>

* Update exposes (#944)

* Add devices-overview page app (#942)

* Use devices-overview-app

* Fix docker-compose.yml for local-run

* Add devices-overview vue app

* Add devices-overview app build

* Set theme jekyll-theme-cayman

* Remove CNAME

* Fix: devices-overview-app hardcoded image url

* Fix device-overview filters

* Make device-overview exposes filter AND

* Readd CNAME

* Read device-addedAt from git and use for sort and label

* Readd CNAME

* Remove old supported devices table view

* Fix docgen test

* Add whitelabel-device icon

* Fix: use original model for whitelabel devices

* Fix minor styles for small devices

* Fix whitelabel flag

* Fix sort by addedAt

* Add model to devices-overview

* Delete docgen.test.js

* Update .eslintignore

* Update .eslintignore

* Update package.json

* Update supported-devices.js

Co-authored-by: Koen Kanters <koenkanters94@gmail.com>

* Add frontend url. Koenkk/zigbee2mqtt#9214

* Added description for Perenio PECLS01 water leak sensor (#950)

* Refactor documentation and use VuePress as generator

* Regenerate device-pages

* Disable codeblock line-numbers on small devices

* 21 10 backdate (#951)

* Add documentation and image for Philips Surimu Rectangle Panel

* Add documentation and image for Philips LTV001 White Ambiance E27 ST64 bulb

* Add documentation and image for Philips LTV001 White Ambiance E27 ST64 bulb

* Not sure what happened here, but it looks like I modified this file so, adding it back!

* Small cleanup

* Add addedAt to device frontmatter

* WIP: Quickstart

* Add more get started stuff

* WIP: quickstart guide

* WIP: quickstart guide

* Minor improvements; WIP getting started

* Edit supported-hardware.md

* Styles; try git-plugin

* Added image for IKEA LED1949C5 (#954)

* add network_key:GENERATE to get-started

* Styles

* Add network_key converter

* disable contributors display

* Point to z2m main repo.

* Updates

* Add list expose (#948)

* Initial

* variant 2

* u

* more variants

* Update exposes.md

* Update exposes.md

* Fix navbar Github link

* Move FAQ to direct child of Guide and fix some links

* Add dark class more early to avoid flickering on page load

* Fix fails to start link in sidebar.

* temporarily enable debug mode

* Invalidate cache

* Disable debug mode, update dependencies

* Refactor FAQ, Z2M fails to start

* Update z2m fails to start.

* try vue patch

* try disable webpack cache

* Remove vue patch; update quasar

* show hide back-to-top also on small devices

* Fix broken links

* change deploy

* Add robots.txt

* develop deploy; fix links

* Fix links

* add docsbranch develop switch

* Readd usb-cable hint

* Fix typo

* Content improvements

* More improvements

* add docsbranch develop switch

* Readd usb-cable hint

* Fix typo

* Disable deploy of develop branch

* WIP: Config refactor

* WIP: Config refactor

* Config refactor

* Config refactor

* Remove develop link from navbar guide

* Fix links

* Small updates to configuration

* Content improvements

* Add workflows

* Philips ltf (#962)

* Added documentation for Philips Apogee devices

* Added images for Philips Apogee devices

* Add sitemap generation

* Add build.txt

* Integrate algolia

* Integrate algolia

* add docsearch plugin

* Fix workflow file

* ci fixes

* Try to better rank device-description search hits

* Wait 1min before first request to build.txt

* Remote start_urls from algolia index

* Update algolia section-selector

* Update navbar active-route links

* Better device-desc search, use @Koenkk's index

* Fix dropdown styles on mobile with dark mode

* Change algolia index

* Fixed Ubisys vendor name (#963)

* Update device-availability.md

* Add images for Tuya TS000x_switch_module (#964)

* Prepare for 1.22.0 release

* Remove unused images

* Use herdsman 14.0.301 and fix links

* Fix: image path, links

* Use www.zigbee2mqtt.io

* Add Notes-Comment test; remove "notes none" sections

* Add Notes-Comment test; remove "notes none" sections

* Change attention comments in device files

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Koen Kanters <koenkanters94@gmail.com>
Co-authored-by: Robin Kolk <robinkolk@msn.com>
Co-authored-by: Koen Kanters <koen.kanters@tno.nl>
Co-authored-by: Burkhard Kneiseler <burkhard@kneiseler.de>
Co-authored-by: Aleks <nitro88@yandex.ru>
Co-authored-by: danieledwardgeorgehitchcock <daniel.edward.george.hitchcock@gmail.com>
Co-authored-by: Dirk van Donkelaar <dirk@vdde.nl>
Co-authored-by: rodriguezst <2828844+rodriguezst@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants