Option documentation

The options to start the manager. You can change the loglvel,…

This file is part of python-openzwave project https://github.com/OpenZWave/python-openzwave.

platform:Unix, Windows, MacOS X sinopsis:openzwave API

License : GPL(v3)

python-openzwave is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

python-openzwave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with python-openzwave. If not, see http://www.gnu.org/licenses.

class openzwave.option.ZWaveOption(device=None, config_path=None, user_path=None, cmd_line=None)

Represents a Zwave option used to start the manager.

config_path

The config path.

Return type:str

device

The device used by the controller.

Return type:str

set_append_log_file(status)

Append new session logs to existing log file (false = overwrite).

Parameters:status (bool) –

set_associate(status)

Enable automatic association of the controller with group one of every device.

Parameters:status (bool) – True to enable logs, False to disable

set_console_output(status)

Display log information on console (as well as save to disk).

Parameters:status (bool) –

set_custom_secured_cc(custom_cc='0x62, 0x4c, 0x63')

What List of Custom CC should we always encrypt if SecurityStrategy is CUSTOM.

Parameters:custom_cc (str) – List of Custom CC

set_driver_max_attempts(attempts)

Set the driver max attempts before raising an error.

Parameters:attempts (int) – Number of attempts

set_dump_trigger_level(level)

Default is to never dump RAM-stored log messages.

Parameters:level –

set_exclude(commandClass)

Remove support for the seted command classes.

Parameters:commandClass (str) – The command class to exclude

set_include(commandClass)

Only handle the specified command classes. The Exclude option is ignored if anything is seted here.

Parameters:commandClass (str) – The location of the log file

set_interface(port)

Identify the serial port to be accessed (TODO: change the code so more than one serial port can be specified and HID).

Parameters:port (str) – The serial port

set_interval_between_polls(status)

Notifications when transaction complete is reported.

Parameters:status (bool) – if false, try to execute the entire poll set within the PollInterval time frame. If true, wait for PollInterval milliseconds between polls

set_log_file(logfile)

Set the log file location.

Parameters:logfile (str) – The location of the log file

set_logging(status)

Set the status of logging.

Parameters:status (bool) – True to activate logs, False to disable

set_notify_transactions(status)

Notifications when transaction complete is reported.

Parameters:status (bool) – True to enable, False to disable

set_poll_interval(interval)

30 seconds (can easily poll 30 values in this time; ~120 values is the effective limit for 30 seconds).

Parameters:interval (int) – interval in seconds

set_queue_log_level(level)

Save (in RAM) log messages equal to or above LogLevel_Debug.

Parameters:level –

set_save_configuration(status)

Save the XML configuration upon driver close.

Parameters:status (bool) – True to enable, False to disable

set_save_log_level(level)

Save (to file) log messages equal to or above LogLevel_Detail.

Parameters:level –

set_security_strategy(strategy='SUPPORTED')

Should we encrypt CC’s that are available via both clear text and Security CC?

Parameters:strategy (str) – The security strategy : SUPPORTED|ESSENTIAL|CUSTOM

set_suppress_value_refresh(status)

if true, notifications for refreshed (but unchanged) values will not be sent.

Parameters:status (bool) – True to enable, False to disable

user_path

The config path.

Return type:str