HABApp
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
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_holiday() (in module HABApp.rule.scheduler)
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() (FilterBuilder static method)
all_modes() (MultiModeItem method)
allow() (Limiter method)
AndFilterGroup (class in HABApp.core.events)
any() (FilterBuilder static method)
at() (HABAppJobBuilder method)
B
b (HSB property)
(RGB property)
BaseValueItem (class in HABApp.core.items)
blue (RGB property)
brightness (HSB property)
buffer (Connection attribute)
C
ca_cert (TLSSettings attribute)
calculate_value() (MultiModeItem method)
CallItem (class in HABApp.openhab.items)
cancel() (CountdownJobControl method)
(DateTimeJobControl method)
(EventListenerGroup method)
(ItemNoChangeWatch method)
(ItemNoUpdateWatch method)
(OneTimeJobControl 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)
command_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)
CompressedMidnightRotatingFileHandler (class in HABApp.config.logging)
config (DirectoriesConfig attribute)
connection (MqttConfig attribute)
(OpenhabConfig attribute)
ContactItem (class in HABApp.openhab.items)
countdown() (HABAppJobBuilder method)
CountdownJobControl (class in HABApp.rule.scheduler.job_builder)
country (LocationConfig attribute)
create_item() (in module HABApp.openhab.interface_sync)
create_link() (in module HABApp.openhab.interface_sync)
D
DatetimeItem (class in HABApp.openhab.items)
DateTimeJobControl (class in HABApp.rule.scheduler.job_builder)
dawn() (TriggerBuilder static method)
days() (FilterBuilder static method)
deactivate_listener() (EventListenerGroup method)
debug (HABAppConfig attribute)
delay (PeriodicTracebackDumpConfig attribute)
delete() (in module HABApp.rule.interfaces.http)
delta_now() (InstantView method)
DictParameter (class in HABApp.parameters)
DimmerItem (class in HABApp.openhab.items)
directories (ApplicationConfig attribute)
down() (RollershutterItem method)
dusk() (TriggerBuilder static method)
E
earliest() (TriggerObject method)
elevation (LocationConfig attribute)
enabled (PeriodicTracebackDumpConfig attribute)
(Ping attribute)
(SwitchItemValueMode property)
(ThreadPoolConfig attribute)
(TLSSettings attribute)
(ValueMode property)
(WatchEventLoopConfig attribute)
ensure_folder() (DirectoriesConfig class method)
EVENT (ItemNoChangeWatch attribute)
(ItemNoUpdateWatch attribute)
EventFilter (class in HABApp.core.events)
EventListenerGroup (class in HABApp.util)
execute_python() (Rule method)
execute_subprocess() (Rule method)
F
Fade (class in HABApp.util)
FilterBuilder (class in eascheduler.builder.filters)
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_holiday_name() (in module HABApp.rule.scheduler)
get_holidays_by_name() (in module HABApp.rule.scheduler)
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_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_sun_position() (in module HABApp.rule.scheduler)
get_thing() (in module HABApp.openhab.interface_sync)
get_topic_qos() (Subscribe method)
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)
group() (TriggerBuilder static method)
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)
HABAppJobBuilder (class in HABApp.rule.scheduler.job_builder)
hits (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
holidays() (FilterBuilder static method)
host (Connection attribute)
HSB (class in HABApp.core.types)
hsb_to_rgb() (in module HABApp.util.functions)
hue (HSB property)
I
id (CountdownJobControl property)
(DateTimeJobControl property)
(OneTimeJobControl property)
identifier (Connection attribute)
ImageItem (class in HABApp.openhab.items)
info() (Limiter method)
insecure (TLSSettings attribute)
InstantView (class in HABApp.core.lib)
interval (PeriodicTracebackDumpConfig attribute)
(Ping attribute)
interval() (TriggerBuilder static method)
is_closed() (ContactItem method)
is_down() (RollershutterItem method)
is_finished (Fade property)
is_holiday() (in module HABApp.rule.scheduler)
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() (TriggerObject 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_run_datetime (CountdownJobControl property)
(DateTimeJobControl property)
(OneTimeJobControl 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() (TriggerObject 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)
module
HABApp.openhab.interface_sync
HABApp.rule.interfaces.http
HABApp.util
months() (FilterBuilder static method)
mqtt (ApplicationConfig attribute)
(built-in class)
MqttItem (class in HABApp.mqtt.items)
MqttPairItem (class in HABApp.mqtt.items)
MqttPublishOptions (class in HABApp.mqtt.util)
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)
newer_than() (InstantView method)
next_run_datetime (CountdownJobControl property)
(DateTimeJobControl property)
(OneTimeJobControl property)
NoEventFilter (class in HABApp.core.events)
noon() (TriggerBuilder static method)
not_() (FilterBuilder static method)
not_work_days() (FilterBuilder static method)
now() (InstantView class method)
NumberItem (class in HABApp.openhab.items)
O
off() (ColorItem method)
(DimmerItem method)
(SwitchItem method)
offset() (TriggerObject 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)
older_than() (InstantView method)
on() (ColorItem method)
(DimmerItem method)
(SwitchItem method)
on_rule_loaded() (Rule method)
on_rule_removed() (Rule method)
once() (HABAppJobBuilder method)
OneTimeJobControl (class in HABApp.rule.scheduler.job_builder)
only_at() (TriggerObject method)
only_on() (TriggerObject method)
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]
pause() (DateTimeJobControl method)
percent() (ColorItem method)
(DimmerItem method)
(RollershutterItem method)
periodic_traceback (DebugConfig attribute)
ping (OpenhabConfig attribute)
PlayerItem (class in HABApp.openhab.items)
pop_holiday() (in module HABApp.rule.scheduler)
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)
(MqttPublishOptions method)
put() (in module HABApp.rule.interfaces.http)
py_datetime() (InstantView method)
py_timedelta() (InstantView method)
Q
qos (MqttPublishOptions property)
(Publish attribute)
(Subscribe attribute)
R
r (RGB property)
RateLimiter() (in module HABApp.util)
red (RGB property)
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)
replace() (HSB method)
(MqttPublishOptions method)
(RGB method)
RequestFileLoadEvent (class in HABApp.core.events.habapp_events)
RequestFileUnloadEvent (class in HABApp.core.events.habapp_events)
reset() (CountdownJobControl method)
(Limiter method)
reset_every (WatchEventLoopConfig attribute)
resume() (DateTimeJobControl method)
retain (MqttPublishOptions property)
(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_countdown() (CountdownJobControl method)
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() (HABAppJobBuilder method)
Statistics (class in HABApp.util)
status (CountdownJobControl property)
(DateTimeJobControl property)
(OneTimeJobControl property)
stop() (CountdownJobControl method)
stop_fade() (Fade method)
StringItem (class in HABApp.openhab.items)
subdivision (LocationConfig attribute)
subscribe (MqttConfig attribute)
subscribe() (mqtt method)
sun_azimuth() (TriggerBuilder static method)
sun_elevation() (TriggerBuilder static method)
sunrise() (TriggerBuilder static method)
sunset() (TriggerBuilder static method)
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() (FilterBuilder static method)
(TriggerBuilder static method)
time_remaining (FixedWindowElasticExpiryLimitInfo attribute)
(LeakyBucketLimitInfo attribute)
timeout (WatchEventLoopConfig attribute)
tls (Connection attribute)
to_hsb() (RGB method)
to_item() (CountdownJobControl method)
(DateTimeJobControl method)
(OneTimeJobControl method)
to_rgb() (HSB method)
to_str() (HABAppException method)
toggle() (SwitchItem method)
topic (MqttPublishOptions property)
topic_filter (Connection attribute)
topics (Subscribe attribute)
total_skips (Limiter property)
(LimiterInfo attribute)
traceback_on_shutdown_signal (DebugConfig attribute)
TriggerBuilder (class in eascheduler.builder.triggers)
TriggerObject (class in eascheduler.builder.triggers)
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)
ValueCommandEvent (class in HABApp.core.events)
ValueCommandEventFilter (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_event_loop (DebugConfig attribute)
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() (FilterBuilder static method)
work_days() (FilterBuilder static method)