Feature: States

Features

Features Home

• AMQP
• Atoms
• Automation
• Cron
• Dynamic DNS
• GPG
• Hooks
• HTTPS
• i10n & i18n
• Local API
• Modules
• MQTT
• Open Source
• Scenes
• States
• Templates

Summary

States represent current values of various items within the automation system. States can include any arbitrary information, such as weather, sunrise/sunset, moon-rise, someone's location, alarm system status, etc.

Examples

• is.sunvisible = True
• is.night = False
• detected_location.city = Folsom
• next.night = 1536200938

States are used inside automation rules as well as inside modules.

Viewing States

View states using the web interface.

Naming conventions

It is recommended to follow these naming conventions when creating new states:

• For anything that is a boolean, start with "is". If it's light outside, the name should be 'is.light'.
• For any items that will occur in the future, start with 'next'. The next sunrise should be called 'next.sunrise'.

See Also

• To view states, see States @ Web Interface
• For use in automation rules, see: Automation Rule @ Features
• For storing static items, see: Atoms @ Features
• For developing a module, see: States @ Library Documentation
• For MQTT topics, see: States @ MQTT Topics
• For detailed python interactions, see: States - Yombo Python API Docs