HABApp
Develop
User Documentation
Installation & Usage
About HABApp
Configuration
Getting Started
Logging
Rule
Parameters
HABApp
openHAB
MQTT
Advanced Usage
asyncio
util - helpers and utilities
Additional rule examples
Tips & Tricks
Troubleshooting
Class reference
HABApp
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
activate_listener() (EventListenerGroup method)
active (EventListenerGroup property)
add_limit() (Limiter method)
add_listener() (EventListenerGroup method)
add_mode() (MultiModeItem method)
add_no_change_watcher() (EventListenerGroup method)
add_no_update_watcher() (EventListenerGroup method)
add_value() (Statistics method)
aggregation_func() (AggregationItem method)
aggregation_period() (AggregationItem method)
aggregation_source() (AggregationItem method)
AggregationItem (class in HABApp.core.items)
all_modes() (MultiModeItem method)
allow() (Limiter method)
AndFilterGroup (class in HABApp.core.events)
at() (HABAppSchedulerView method)
B
b (HSB property)
(RGB property)
BaseValueItem (class in HABApp.core.items)
blue (RGB property)
boundary_func() (DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
brightness (HSB property)
buffer (Connection attribute)
C
ca_cert (TLSSettings attribute)
calculate_value() (MultiModeItem method)
CallItem (class in HABApp.openhab.items)
cancel() (CountdownJob method)
(DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(EventListenerGroup method)
(ItemNoChangeWatch method)
(ItemNoUpdateWatch method)
(OneTimeJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
(SwitchItemValueMode method)
(ValueMode method)
ChannelTriggeredEvent (class in HABApp.openhab.events)
closed() (ContactItem method)
ColorItem (class in HABApp.core.items)
(class in HABApp.openhab.items)
CompressedMidnightRotatingFileHandler (class in HABApp.config.logging)
config (DirectoriesConfig attribute)
connection (MqttConfig attribute)
(OpenhabConfig attribute)
ContactItem (class in HABApp.openhab.items)
countdown() (CountdownJob method)
(HABAppSchedulerView method)
CountdownJob (class in HABApp.rule.scheduler.jobs)
create_item() (in module HABApp.openhab.interface_sync)
create_link() (in module HABApp.openhab.interface_sync)
D
DatetimeItem (class in HABApp.openhab.items)
DawnJob (class in HABApp.rule.scheduler.jobs)
DayOfWeekJob (class in HABApp.rule.scheduler.jobs)
deactivate_listener() (EventListenerGroup method)
delete() (in module HABApp.rule.interfaces.http)
DictParameter (class in HABApp.parameters)
DimmerItem (class in HABApp.openhab.items)
directories (ApplicationConfig attribute)
down() (RollershutterItem method)
DuskJob (class in HABApp.rule.scheduler.jobs)
E
earliest() (DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
elevation (LocationConfig attribute)
enabled (Ping attribute)
(SwitchItemValueMode property)
(ThreadPoolConfig attribute)
(TLSSettings attribute)
(ValueMode property)
ensure_folder() (DirectoriesConfig class method)
EVENT (ItemNoChangeWatch attribute)
(ItemNoUpdateWatch attribute)
EventFilter (class in HABApp.core.events)
EventListenerGroup (class in HABApp.util)
every() (HABAppSchedulerView method)
every_hour() (HABAppSchedulerView method)
every_minute() (HABAppSchedulerView method)
execute_python() (Rule method)
execute_subprocess() (Rule method)
F
Fade (class in HABApp.util)
FinishedProcessInfo (class in HABApp.rule)
FixedWindowElasticExpiryLimitInfo (class in HABApp.util.rate_limiter.limiter)
flush_every (LoggingConfig attribute)
from_hsb() (RGB class method)
from_rgb() (HSB class method)
G
g (RGB property)
general (MqttConfig attribute)
(OpenhabConfig attribute)
get() (in module HABApp.rule.interfaces.http)
get_client_session() (in module HABApp.rule.interfaces.http)
get_create_item() (AggregationItem class method)
(ColorItem class method)
(Item class method)
(MqttItem class method)
(MqttPairItem class method)
(MultiModeItem class method)
get_item() (AggregationItem class method)
(BaseValueItem class method)
(CallItem class method)
(ColorItem class method)
,
[1]
(ContactItem class method)
(DatetimeItem class method)
(DimmerItem class method)
(GroupItem class method)
(ImageItem class method)
(in module HABApp.openhab.interface_sync)
(Item class method)
(LocationItem class method)
(MqttItem class method)
(MqttPairItem class method)
(NumberItem class method)
(PlayerItem class method)
(RollershutterItem class method)
(StringItem class method)
(SwitchItem class method)
(Thing class method)
get_items() (Rule static method)
get_link() (in module HABApp.openhab.interface_sync)
get_mode() (MultiModeItem method)
get_next_run() (CountdownJob method)
(DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(OneTimeJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
get_persistence_data() (CallItem method)
(ColorItem method)
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(in module HABApp.openhab.interface_sync)
(LocationItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
get_persistence_services() (in module HABApp.openhab.interface_sync)
get_rgb() (ColorItem method)
,
[1]
get_thing() (in module HABApp.openhab.interface_sync)
get_value() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(Fade method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
green (RGB property)
GroupItem (class in HABApp.openhab.items)
GroupStateChangedEvent (class in HABApp.openhab.events)
H
h (HSB property)
habapp (ApplicationConfig attribute)
HABApp.openhab.interface_sync
module
HABApp.rule.interfaces.http
module
HABApp.util
module
HABAppException (class in HABApp.core.events.habapp_events)
HABAppSchedulerView (class in HABApp.rule.scheduler)
hits (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
host (Connection attribute)
HSB (class in HABApp.core.types)
hsb_to_rgb() (in module HABApp.util.functions)
hue (HSB property)
I
identifier (Connection attribute)
ImageItem (class in HABApp.openhab.items)
info() (Limiter method)
insecure (TLSSettings attribute)
interval (Ping attribute)
interval() (ReoccurringJob method)
is_closed() (ContactItem method)
is_down() (RollershutterItem method)
is_finished (Fade property)
is_off() (ColorItem method)
,
[1]
(DimmerItem method)
(SwitchItem method)
is_on() (ColorItem method)
,
[1]
(DimmerItem method)
(SwitchItem method)
is_open() (ContactItem method)
is_up() (RollershutterItem method)
Item (class in HABApp.core.items)
item (Ping attribute)
item_exists() (in module HABApp.openhab.interface_sync)
ItemAddedEvent (class in HABApp.openhab.events)
ItemCommandEvent (class in HABApp.openhab.events)
ItemCommandEventFilter (class in HABApp.openhab.events)
ItemNoChangeEvent (class in HABApp.core.events)
ItemNoChangeWatch (class in HABApp.core.items.base_item_watch)
ItemNoUpdateEvent (class in HABApp.core.events)
ItemNoUpdateWatch (class in HABApp.core.items.base_item_watch)
ItemRemovedEvent (class in HABApp.openhab.events)
ItemStateChangedEvent (class in HABApp.openhab.events)
ItemStateChangedEventFilter (class in HABApp.openhab.events)
ItemStateEvent (class in HABApp.openhab.events)
ItemStatePredictedEvent (class in HABApp.openhab.events)
ItemStateUpdatedEventFilter (class in HABApp.openhab.events)
ItemUpdatedEvent (class in HABApp.openhab.events)
J
jitter() (DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
L
last_change (AggregationItem property)
(BaseValueItem property)
(CallItem property)
(ColorItem property)
,
[1]
(ContactItem property)
(DatetimeItem property)
(DimmerItem property)
(GroupItem property)
(ImageItem property)
(Item property)
(LocationItem property)
(MqttItem property)
(MqttPairItem property)
(NumberItem property)
(PlayerItem property)
(RollershutterItem property)
(StringItem property)
(SwitchItem property)
(Thing property)
last_update (AggregationItem property)
(BaseValueItem property)
(CallItem property)
(ColorItem property)
,
[1]
(ContactItem property)
(DatetimeItem property)
(DimmerItem property)
(GroupItem property)
(ImageItem property)
(Item property)
(LocationItem property)
(MqttItem property)
(MqttPairItem property)
(NumberItem property)
(PlayerItem property)
(RollershutterItem property)
(StringItem property)
(SwitchItem property)
(Thing property)
latest() (DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
latitude (LocationConfig attribute)
LeakyBucketLimitInfo (class in HABApp.util.rate_limiter.limiter)
lib (DirectoriesConfig attribute)
limit (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
Limiter (class in HABApp.util.rate_limiter.limiter)
LimiterInfo (class in HABApp.util.rate_limiter.limiter)
limits (LimiterInfo attribute)
listen() (EventListenerGroup method)
listen_event() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(ItemNoChangeWatch method)
(ItemNoUpdateWatch method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(Rule method)
(StringItem method)
(SwitchItem method)
(Thing method)
listen_only (General attribute)
,
[1]
location (ApplicationConfig attribute)
LocationItem (class in HABApp.openhab.items)
logging (DirectoriesConfig attribute)
(HABAppConfig attribute)
longitude (LocationConfig attribute)
M
max() (in module HABApp.util.functions)
members (GroupItem property)
MidnightRotatingFileHandler (class in HABApp.config.logging)
min() (in module HABApp.util.functions)
min_start_level (General attribute)
min_uptime (General attribute)
model_computed_fields (ApplicationConfig attribute)
(Connection attribute)
,
[1]
(DirectoriesConfig attribute)
(General attribute)
,
[1]
(HABAppConfig attribute)
(LocationConfig attribute)
(LoggingConfig attribute)
(MqttConfig attribute)
(OpenhabConfig attribute)
(Ping attribute)
(Publish attribute)
(Subscribe attribute)
(ThreadPoolConfig attribute)
(TLSSettings attribute)
module
HABApp.openhab.interface_sync
HABApp.rule.interfaces.http
HABApp.util
mqtt (ApplicationConfig attribute)
(built-in class)
MqttItem (class in HABApp.mqtt.items)
MqttPairItem (class in HABApp.mqtt.items)
MqttValueChangeEvent (class in HABApp.mqtt.events)
MqttValueUpdateEvent (class in HABApp.mqtt.events)
MultiModeItem (class in HABApp.util.multimode)
N
name (AggregationItem property)
(BaseValueItem property)
(CallItem property)
(ColorItem property)
,
[1]
(ContactItem property)
(DatetimeItem property)
(DimmerItem property)
(GroupItem property)
(ImageItem property)
(Item property)
(LocationItem property)
(MqttItem property)
(MqttPairItem property)
(NumberItem property)
(PlayerItem property)
(RollershutterItem property)
(StringItem property)
(SwitchItem property)
(Thing property)
NoEventFilter (class in HABApp.core.events)
NumberItem (class in HABApp.openhab.items)
O
off() (ColorItem method)
(DimmerItem method)
(SwitchItem method)
offset() (DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
oh_post_update() (CallItem method)
(ColorItem method)
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(LocationItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
oh_post_update_if() (CallItem method)
(ColorItem method)
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(LocationItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
oh_send_command() (CallItem method)
(ColorItem method)
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(LocationItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
on() (ColorItem method)
(DimmerItem method)
(SwitchItem method)
on_day_of_week() (HABAppSchedulerView method)
on_every_day() (HABAppSchedulerView method)
on_rule_loaded() (Rule method)
on_rule_removed() (Rule method)
on_sun_dawn() (HABAppSchedulerView method)
on_sun_dusk() (HABAppSchedulerView method)
on_sunrise() (HABAppSchedulerView method)
on_sunset() (HABAppSchedulerView method)
on_weekends() (HABAppSchedulerView method)
on_workdays() (HABAppSchedulerView method)
OneTimeJob (class in HABApp.rule.scheduler.jobs)
open() (ContactItem method)
openhab (ApplicationConfig attribute)
OrFilterGroup (class in HABApp.core.events)
P
param (DirectoriesConfig attribute)
Parameter (class in HABApp.parameters)
parse_limits() (Limiter method)
password (Connection attribute)
,
[1]
percent() (ColorItem method)
(DimmerItem method)
(RollershutterItem method)
ping (OpenhabConfig attribute)
PlayerItem (class in HABApp.openhab.items)
port (Connection attribute)
post() (in module HABApp.rule.interfaces.http)
post_event() (Rule method)
post_rgb() (ColorItem method)
,
[1]
post_update() (in module HABApp.openhab.interface_sync)
post_value() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
post_value_if() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
publish (MqttConfig attribute)
publish() (mqtt method)
(MqttItem method)
(MqttPairItem method)
put() (in module HABApp.rule.interfaces.http)
Q
qos (Publish attribute)
(Subscribe attribute)
R
r (RGB property)
RateLimiter() (in module HABApp.util)
red (RGB property)
remaining() (CountdownJob method)
(DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(OneTimeJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
remove_item() (in module HABApp.openhab.interface_sync)
remove_link() (in module HABApp.openhab.interface_sync)
remove_metadata() (in module HABApp.openhab.interface_sync)
remove_mode() (MultiModeItem method)
ReoccurringJob (class in HABApp.rule.scheduler.jobs)
replace() (HSB method)
(RGB method)
RequestFileLoadEvent (class in HABApp.core.events.habapp_events)
RequestFileUnloadEvent (class in HABApp.core.events.habapp_events)
reset() (Limiter method)
retain (Publish attribute)
RGB (class in HABApp.core.types)
rgb_to_hsb() (in module HABApp.util.functions)
RollershutterItem (class in HABApp.openhab.items)
Rule (class in HABApp)
rules (DirectoriesConfig attribute)
S
s (HSB property)
saturation (HSB property)
schedule_fade() (Fade method)
send_command() (in module HABApp.openhab.interface_sync)
set_enabled() (Thing method)
(ValueMode method)
set_file_validator() (in module HABApp.parameters)
set_metadata() (in module HABApp.openhab.interface_sync)
set_persistence_data() (in module HABApp.openhab.interface_sync)
set_rgb() (ColorItem method)
,
[1]
set_thing_enabled() (in module HABApp.openhab.interface_sync)
set_value() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
(SwitchItemValueMode method)
(ValueMode method)
setup() (Fade method)
skips (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
(LimiterInfo attribute)
soon() (HABAppSchedulerView method)
Statistics (class in HABApp.util)
stop() (CountdownJob method)
stop_fade() (Fade method)
StringItem (class in HABApp.openhab.items)
subscribe (MqttConfig attribute)
subscribe() (mqtt method)
SunriseJob (class in HABApp.rule.scheduler.jobs)
SunsetJob (class in HABApp.rule.scheduler.jobs)
SwitchItem (class in HABApp.openhab.items)
SwitchItemValueMode (class in HABApp.util.multimode)
T
test_allow() (Limiter method)
Thing (class in HABApp.openhab.items)
ThingAddedEvent (class in HABApp.openhab.events)
ThingFirmwareStatusInfoEvent (class in HABApp.openhab.events)
ThingRemovedEvent (class in HABApp.openhab.events)
ThingStatusInfoChangedEvent (class in HABApp.openhab.events)
ThingStatusInfoEvent (class in HABApp.openhab.events)
ThingUpdatedEvent (class in HABApp.openhab.events)
thread_pool (HABAppConfig attribute)
threads (ThreadPoolConfig attribute)
time() (DayOfWeekJob method)
time_remaining (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
tls (Connection attribute)
to_hsb() (RGB method)
to_item() (CountdownJob method)
(DawnJob method)
(DayOfWeekJob method)
(DuskJob method)
(OneTimeJob method)
(ReoccurringJob method)
(SunriseJob method)
(SunsetJob method)
to_rgb() (HSB method)
to_str() (HABAppException method)
toggle() (SwitchItem method)
topic_filter (Connection attribute)
topics (Subscribe attribute)
total_skips (Limiter property)
(LimiterInfo attribute)
U
unit (NumberItem property)
unsubscribe() (mqtt method)
up() (RollershutterItem method)
update() (Statistics method)
url (Connection attribute)
use_buffer (LoggingConfig attribute)
user (Connection attribute)
,
[1]
V
value (DictParameter property)
(Parameter property)
(SwitchItemValueMode property)
(ValueMode property)
ValueChangeEvent (class in HABApp.core.events)
ValueChangeEventFilter (class in HABApp.core.events)
ValueMode (class in HABApp.util.multimode)
ValueUpdateEvent (class in HABApp.core.events)
ValueUpdateEventFilter (class in HABApp.core.events)
verify_ssl (Connection attribute)
W
wait_for_openhab (General attribute)
watch_change() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
(Thing method)
watch_update() (AggregationItem method)
(BaseValueItem method)
(CallItem method)
(ColorItem method)
,
[1]
(ContactItem method)
(DatetimeItem method)
(DimmerItem method)
(GroupItem method)
(ImageItem method)
(Item method)
(LocationItem method)
(MqttItem method)
(MqttPairItem method)
(NumberItem method)
(PlayerItem method)
(RollershutterItem method)
(StringItem method)
(SwitchItem method)
(Thing method)
weekdays() (DayOfWeekJob method)
Read the Docs
v: Develop
Versions
latest
stable
24.02.0
24.01.0
23.11.0
23.09.2
23.09.1
23.09.0
v1.1.2
v1.1.1
v1.1.0
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.31.2
v0.31.1
v0.31.0
v0.30.3
v0.30.2
v0.30.1
0.30.0
0.20.2
0.20.1
develop
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds