|  Developer
Updated on March 28, 2023

Zwave module API (require “zwave”)

Functions
Return Name and parameters
none reset()
none start_include( [opt] device_setting_file_path: string )
none start_rediscover( node_id: number, device_setting_file_path: string )
none start_exclude()
none start_learn()
string subscribe( script_name: string, [opt] events_filter: table )
none set_subscription_filters( subscriber_id: string, filter_rules: table(array) )
none unsubscribe( subscriber_id: string )
none set_device_specific_key( key: number )
none set_auth_mode( modes: table )
none stop_include()
none stop_learn()
none stop_security_include()
none set_devices_poll_intervals( use_fixed_wake_up_interval : bool, wake_up_interval : number, always_on_devices_inetrval : number, attempts_count : number )
none set_unresponsive_device_ignore_interval (interval : number)
none reconstruct_network()
none set_default_device_configurations_file (file_path : string)
table get_all_nodes_ids()
bool has_node( node_id: number )
table get_node( node_id: number )
table get_node_info( node_id: number )
string get_manufacturer_name( manufacturer_id: number )
string get_command_class( node_id: number, channel_id: number, class_id: number )
none set_value( node_id: number, class_id: number, channel_id: number, value: boolean or number )
none set_value_multicast( node_ids: table, class_id: number, channel_id: number, value: boolean or number, mode: string (opt) )
none set_token_value( node_id: number, class_id: number, channel_id: number, value: string )
none set_token_value_multicast( node_ids: table, class_id: number, channel_id: number, value: string, mode: string (opt) )
none set_rgb_value( node_id: number, class_id: number, channel_id: number, value: table )
none set_rgb_value_multicast( node_ids: table, class_id: number, channel_id: number, value: table, mode: string (opt) )
none set_sound_switch_configuration( node_id: number, class_id: number, channel_id: number, volume: number, default_tone_id: number )
none request_sound_switch_configuration()
none set_sound_switch_tone_play( node_id: number, class_id: number, channel_id: number, tone_id: number, volume: number )
none request_sound_switch_tone_play()
none set_door_lock_mode( node_id: number, channel_id: number, value: string )
none request_door_lock_mode( node_id: number, channel_id: number )
none set_door_lock_configuration( node_id: number, channel_id: number, configuration: table )
none request_door_lock_configuration( node_id: number, channel_id: number )
none set_setpoint_value( node_id: number, class_id: number, channel_id: number, setpoint_type: number, value: table )
none add_configuration( node_id: number, channel_id: number, param_number: number, param_size: number )
none remove_configuration( node_id: number, channel_id: number, param_number: number )
none set_configuration_value( node_id: number, param_number: number, param_size: number, value: number )
none reset_configuration_value( node_id: number, param_number: number )
none reset_all_configuration_values( node_id: number )
none switch_multilevel_level_change( node_id: number, channel_id: number, command: string, [opt] duration: number )
none request_value( node_id: number, class_id: number, channel_id: number )
none request_node_values( node_id: number, request_delay: number )
none request_setpoint_value( node_id: number, channel_id: number, setpoint_type: number )
none request_master_code( node_id: number, channel_id: number )
none request_user_codes_keypad_mode( node_id: number, channel_id: number )
none request_user_code( node_id: number, channel_id: number, [opt] user_id: number )
none request_user_codes_checksum( node_id: number, channel_id: number )
none calculate_user_codes_checksum( _user_codes: array of user code elements)
none request_configuration_value( node_id: number, channel_id: number, param_number: number )
none request_association_group( node_id: number, channel_id: number, group_id: number )
none add_node_to_association_group( node_id: number, channel_id: number, group_id: number, destination_node: number, [opt] destination_endpoint: number )
none remove_node_from_association_group( node_id: number, channel_id: number, group_id: number, destination_node: number, [opt] destination_endpoint: number )
none set_user_code( node_id: number, channel_id: number, user_id: number, user_id_status: number, user_code: string )
none set_master_code( node_id: number, channel_id: number, master_code: string )
none set_user_codes_keypad_mode( node_id: number, channel_id: number, mode: string )
none set_silent_sensors( node_id: number, channel_id: number, sound_delay: number, sensor_names: table )
none send_identify( node_id: number, channel_id: number )
none request_alarm_sensor_value( node_id: number, channel_id: number, sensor_name: string )
none set_week_day_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number, week_day_entry_lock_schedule: table )
none request_week_day_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number )
none set_daily_repeating_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number, daily_repeating_entry_lock_schedule: table )
none request_daily_repeating_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number )
none set_year_day_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number, year_day_entry_lock_schedule: table )
none request_year_day_entry_lock_schedule( node_id: number, channel_id: number, user_id: number, slot_id: number )
none reset_meter( node_id: number, channel_id: number, [opt] value: number, [opt]value_size: number )
none request_meter( node_id: number, channel_id: number, scale: string )
table get_provisioning_info( node_id: number )
none set_provisioning_info( node_id: number, name: string, room: string )
table get_info()
string get_firmware_region()
none update_nodes_firmware( node_ids: array of numbers, firmware: array of objects )
none request_notification_value( node_id: number, channel_id: number, notification_type: string, notification_event: string )
none request_alarm_v1_value( node_id: number, channel_id: number, alarm_v1_type: number )
none set_barrier_signal_value( node_id: number, channel_id: number, signal_name: string, value: number )
none request_barrier_signal_value( node_id: number, channel_id: number, signal_name: string )
none set_thermostat_setback_value( node_id: number, channel_id: number, override_type: string, mode: string, value: number (opt) )
none check_reachable_status( node_id: number )
none check_node_values( node_id: number, request_delay: number, cc_to_check: array )
none color_switch_level_change( node_id: number, channel_id: number, color_component: string, command: string, [opt] duration: number )
none lock_anti_theft( node_id: number, channel_id: number, magic_code: string, hint: string)
none unlock_anti_theft( node_id: number, channel_id: number, class_id: number, magic_code: string )
none lock_anti_theft_default( node_id: number, channel_id: number )
none unlock_anti_theft_default( node_id: number, channel_id: number, class_id: number, hint: string )
none add_device_specific_configuration( device_type_id: string, configuration: object )
none add_device_specific_association( device_type_id: string, association: object )
none clear_device_specific()