Configuration¶

Sample Configuration¶

# /usr/local/smarthome/etc/smarthome.conf

lat = 51.1633
lon = 10.4476
elev = 500

tz = 'Europe/Berlin'

watch_item¶

The list of items will be monitored for changes.

watch_item = house.door | terrace.door

Every change of these two items triggers (run) the logic. Or you could use a regular expression:

watch_item = *.door

cycle¶

Defines the time interval for repeating the logic (in seconds).

cycle = 60

Special use:

cycle = 15 = 42

Calls the logic with trigger[‘value’] # == ‘42’

crontab¶

Like Unix crontab with the following options:

crontab = init Run the logic during the start of SmartHome.py.

crontab = minute hour day wday

• minute: single value from 0 to 59, or comma separated list, or * (every minute)
• hour: single value from 0 to 23, or comma separated list, or * (every hour)
• day: single value from 0 to 28, or comma separated list, or * (every day) Please note: dont use days greater than 28 in the moment.
• wday: weekday, single value from 0 to 6 (0 = Monday), or comma separated list, or * (every day)

crontab = sunrise Runs the logic at every sunrise. Use sunset to run at sunset. For sunset / sunrise you could provide:

• an horizon offset in degrees e.g. crontab = sunset-6 You have to specify your latitude/longitude in smarthome.conf.

• an offset in minutes specified by a ‘m’ e.g. crontab = sunset-10m

• a boundary for the execution

  crontab = 17:00<sunset  # sunset, but not bevor 17:00 (locale time)
  crontab = sunset<20:00  # sunset, but not after 20:00 (locale time)
  crontab = 17:00<sunset<20:00  # sunset, beetween 17:00 and 20:00

crontab = 15 * * * = 50 Calls the logic with trigger[‘value’] # == 50

Combine several options with ‘|’:

crontab = init = 'start' | sunrise-2 | 0 5 * *

prio¶

Priority of the logic used by the internal scheduling table. By default every logic has the the priority of ‘3’. You could assign [0-10] as a value. You could change it to ‘1’ to prefer or to ‘4’ to penalise the logic in comparison to other logics.

Other attributes¶

Other attributes could be accessed from the the logic with self.attribute_name.

Sample logic.conf¶

# /usr/local/smarthome/etc/logic.conf
[Time]
    filename = time.py
    cyle = 60

[DoorBell]
    filename = bell.py
    watch_item = dorr.bell # monitor for changes

[Blind Living]
    filename = blind.py
    crontab = 10,25,40,55 * * * # run every 15 minutes
    # cycle = 900 # could be used instead
    sunshine = no # accessed by self.sunshine

[BlindKitchen]
    filename = blind.py  # you could run the same logic file several times
    crontab = 10,25,40,55 * * * # run every 15 minutes
    sunshine = yes

Configuration¶

Plugins are configured in the plugin.conf file. A simple plugin.conf:

# /usr/local/smarthome/etc/plugin.conf
[notify] # object instance name e.g. sh.notify
    class_name = Prowl # class name of the python class
    class_path = plugins.prowl # path to the plugin
    apikey = abc123abc123 # attribute for the plugin e.g. secret key for prowl

The object name, class name and class path must be provided. The other attributes depend on the individual plugin. See the corresponding plugin page for more information.

The example above would generate the following statement sh.notify = plugins.prowl.Prowl(apikey='abc123abc123'). From now on there is the object sh.notify and you could access the function of this object with sh.notify.function().

Item Attributes¶

• type: for storing values and/or triggering actions you have to specify this attribute. (If you do not specify this attribute the item is only useful for structuring your item tree). Supported types: - bool: boolean type (on, 1, True or off, 0, False). True or False are internally used. Use e.g. if sh.item(): .... - num: any number (integer or float). - str: regular string or unicode string. - list: list/array of values. Usefull e.g. for some KNX dpts. - dict: python dictionary for generic purposes. - foo: pecial purposes. No validation is done. - scene: special keyword to support scenes
• value: initial value of that item.
• name: name which would be the str representation of the item (optional).
• cache: if set to On, the value of the item will be cached in a local file (in /usr/local/smarthome/var/cache/).
• enforce_updates: If set to On, every call of the item will trigger depending logics and item evaluations.
• threshold: specify values to trigger depending logics only if the value transit the threshold. low:high to set a value for the lower and upper threshold, e.g. 21.4:25.0 which triggers the logic if the value exceeds 25.0 or fall below 21.4. Or simply a single value.
• eval and eval_trigger: see next section for a description of these attributes.
• crontab and cycle: see logic.conf for possible options to set the value of an item at the specified times / cycles.
• autotimer see the item function below. e.g. autotimer = 10m = 42

# items/example.conf
[example]
    type = scene
[otheritem]
    type = num

# scenes/example.conf
0 otheritem 2
1 otheritem 20
1 LogicName run
2 otheritem 55
3 LogicName stop

# items/level.conf
[level]
    type = num
    eval = value * 2 - 1  # if you call sh.level(3) sh.level will be evaluated and set to 5

# items/room.conf
[room]
    [[temp]]
        type = num
    [[hum]]
        type = num
    [[dew]]
        type = num
        eval = sh.tools.dewpoint(sh.room.temp(), sh.room.hum())
        eval_trigger = room.temp | room.hum  # every change of temp or hum would trigger the evaluation of dew.

# items/rooms.conf
[room_a]
    [[temp]]
        type = num
    [[presence]]
        type = bool
[room_b]
    [[temp]]
        type = num
    [[presence]]
        type = bool
[rooms]
    [[temp]]
        type = num
        name = average temperature
        eval = avg
        eval_trigger = room_a.temp | room_b.temp
    [[presence]]
        type = bool
        name = movement in on the rooms
        eval = or
        eval_trigger = room_a.presence | room_b.presence

Item Functions¶

Every item provides the following methods: