Skip to content

Add a note about the location of the event emitting function to the Shelly documentation #38447

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 9, 2025
Merged

Add a note about the location of the event emitting function to the Shelly documentation #38447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4082fd9
Add note about emitEvent
bieniu Apr 8, 2025
5d7d28f
Apply code rabbit suggestion
bieniu Apr 8, 2025
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
4 changes: 4 additions & 0 deletions source/_integrations/shelly.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ If the **Input Mode** of the switch connected to the device is set to `Button`,

Each script which generates events using [Shelly.emitEvent()](https://shelly-api-docs.shelly.cloud/gen2/Scripts/ShellyScriptLanguageFeatures#shellyemitevent) also gets an corresponding event entity. This entity is disabled by default. After changing a script, it's required to manually reload the device before new event types show up.

{% note %}
To avoid increased startup time, only the first 5 KB of the script is downloaded and analyzed. If your script exceeds 5 KB, place the event emitting function at the beginning to ensure it is processed.
{% endnote %}

For example, the following script will emit an event every time an input (button or switch) on the device is changed.

```javascript
Expand Down