Function Class Reference

Function Class GetSerialAPICapabilities

Syntax: GetSerialAPICapabilities(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_serial_api_capabilities(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request Serial API capabilities
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: capabilities, manufacturerId, manufacturerProductId, manufacturerProductType, APIVersion, vendor

Function Class SerialAPISetTimeouts

Syntax: SerialAPISetTimeouts(ackTimeout, byteTimeout, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_set_timeouts(ZWay zway, ZWBYTE ackTimeout, ZWBYTE byteTimeout, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set Serial API timeouts
Parameter ackTimeout: Time for the stick to wait for ACK (in 10ms units)
Parameter byteTimeout: Time for the stick to assemble a full packet (in 10ms units)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: curSerialAPIAckTimeout10ms, curSerialAPIByteTimeout10ms, oldSerialAPIAckTimeout10ms, oldSerialAPIByteTimeout10ms

Function Class SerialAPIGetInitData

Syntax: SerialAPIGetInitData(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_get_init_data(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request initial information about devices in network
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: ZWVersion, ZWaveChip, list of Z-Wave devices is generated

Function Class SerialAPIApplicationNodeInfo

Syntax: SerialAPIApplicationNodeInfo(listening, optional, flirs1000, flirs250, genericClass, specificClass, nif, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_application_node_info(ZWay zway, ZWBOOL listening, ZWBOOL optional, ZWBOOL flirs1000, ZWBOOL flirs250, ZWBYTE generic_class, ZWBYTE specific_class, const ZWBYTE * nif, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set controller node information
Parameter listening: Listening flag
Parameter optional: Optional flag (set if device supports more CCs than described as mandatory for it's Device Type)
Parameter flirs1000: FLiRS 1000 flag (hardware have to be based on FLiRS library to support it)
Parameter flirs250: FLiRS 250 flag (hardware have to be based on FLiRS library to support it)
Parameter genericClass: Generic Device Type
Parameter specificClass: Specific Device Type
Parameter nif: New NIF
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class WatchDogStart

Syntax: WatchDogStart(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_watchdog_start(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Start WatchDog
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class WatchDogStop

Syntax: WatchDogStop(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_watchdog_stop(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Stop WatchDog
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class GetHomeId

Syntax: GetHomeId(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_home_id(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request Home Id and controller Node Id
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: homeId, nodeId

Function Class GetControllerCapabilities

Syntax: GetControllerCapabilities(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_controller_capabilities(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request controller capabilities (primary role, SUC/SIS availability)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: isInOthersNetwork, isPrimary, isRealPrimary, isSUC, isSUC, SISPresent

Function Class GetVersion

Syntax: GetVersion(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_version(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request controller hardware version
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: ZWLib, ZWProtocolMajor, ZWProtocolMinor, libType, SDK, devices[ctrlId].data.ZWLib, devices[ctrlId].data.ZWProtocolMajor, devices[ctrlId].data.ZWProtocolMinor, devices[ctrlId].data.SDK

Function Class GetSUCNodeId

Syntax: GetSUCNodeId(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_suc_node_id(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request SUC Node Id
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: SUCNodeId

Function Class EnableSUC

Syntax: EnableSUC(enable, sis, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_enable_suc(ZWay zway, ZWBOOL enable, ZWBOOL sis, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Enable or disable SUC/SIS functionality of the controller
Parameter enable: True to enable functionality, False to disable
Parameter sis: True to enable SIS functionality, False to enable SUC only
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SetSUCNodeId

Syntax: SetSUCNodeId(nodeId, enable, sis, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_set_suc_node_id(ZWay zway, ZWBYTE node_id, ZWBOOL enable, ZWBOOL sis, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Assign new SUC/SIS or disable existing
Parameter nodeId: Node Id to be assigned/disabled as SUC/SIS
Parameter enable: True to enable, False to disable
Parameter sis: True to assign SIS role, False to enable SUC role only
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class MemoryGetByte

Syntax: MemoryGetByte(offset, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_memory_get_byte(ZWay zway, unsigned short offset, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Read single byte from EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: memoryGetData, memoryGetAddress

Function Class MemoryGetBuffer

Syntax: MemoryGetBuffer(offset, length, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_memory_get_buffer(ZWay zway, unsigned short offset, ZWBYTE length, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Read multiple bytes from EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter length: Number of byte to be read
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: memoryGetData, memoryGetAddress

Function Class MemoryPutByte

Syntax: MemoryPutByte(offset, data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_memory_put_byte(ZWay zway, unsigned short offset, ZWBYTE data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Write single byte to EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter data: Byte to be written
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class MemoryPutBuffer

Syntax: MemoryPutBuffer(offset, data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_memory_put_buffer(ZWay zway, unsigned short offset, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Write multiple bytes to EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter data: Bytes to be written
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class NVMGetId

Syntax: NVMGetId(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_nvm_get_id(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Read type of extended EEPROM
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: memoryCapacity, memoryManufacturerId, memoryType

Function Class NVMExtReadLongByte

Syntax: NVMExtReadLongByte(offset, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_nvm_ext_read_long_byte(ZWay zway, unsigned int offset, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Read single byte from extended EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: memoryGetData, memoryGetAddress

Function Class NVMExtReadLongBuffer

Syntax: NVMExtReadLongBuffer(offset, length, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_nvm_ext_read_long_buffer(ZWay zway, unsigned int offset, unsigned short length, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Read multiple bytes from exended EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter length: Number of byte to be read
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: memoryGetData, memoryGetAddress

Function Class NVMExtWriteLongByte

Syntax: NVMExtWriteLongByte(offset, data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_nvm_ext_write_long_byte(ZWay zway, unsigned int offset, ZWBYTE data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Write single byte to extended EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter data: Byte to be written
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class NVMExtWriteLongBuffer

Syntax: NVMExtWriteLongBuffer(offset, data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_nvm_ext_write_long_buffer(ZWay zway, unsigned int offset, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Write multiple bytes to extended EEPROM
Parameter offset: Offset in application memory in EEPROM
Parameter data: Bytes to be written
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class IsFailedNode

Syntax: IsFailedNode(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_is_failed_node(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Checks if node is failed
Parameter nodeId: Node Id to be checked
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: device[node_id].data.isFailed

Function Class SendDataAbort

Syntax: SendDataAbort(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_data_abort(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Abort send data. Note that this function works unpredictably in multi callback environment !
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SerialAPISoftReset

Syntax: SerialAPISoftReset(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_soft_reset(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Soft reset. Restarts Z-Wave chip
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SendData

Syntax: SendData(nodeId, data, description = NULL, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_data(ZWay zway, ZWBYTE node_id, const ZWBYTE * data, ZWCSTR description, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Send data. Packets are sent in AUTO_ROUTE mode with EXPLRER_FRAME enabled for listening devices (ignored if not supported by the hardware [based on 5.0x branch])
Parameter nodeId: Destination Node Id (NODE_BROADCAST to send non-routed broadcast packet)
Parameter data: Paket payload
Parameter description: Packet description for queue inspector and logging
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.lastSend

Function Class SendDataSecure

Syntax: SendDataSecure(nodeId, data, description = NULL, keyClass = 0, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_data_secure(ZWay zway, ZWBYTE node_id, const ZWBYTE * data, ZWCSTR description, ZWBYTE key_class, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Send data using security. Packets are sent in AUTO_ROUTE mode with EXPLRER_FRAME enabled for listening devices (ignored if not supported by the hardware [based on 5.0x branch]). Explicitelly use security
Parameter nodeId: Destination Node Id (NODE_BROADCAST to send non-routed broadcast packet)
Parameter data: Paket payload
Parameter description: Packet description for queue inspector and logging
Parameter keyClass: Security class to use: 0 - S0, 1 - S2 Unauthenticated, 2 - S2 Authenticated, 4 - S2 Access
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.lastSend

Function Class GetNodeProtocolInfo

Syntax: GetNodeProtocolInfo(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_node_protocol_info(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get node protocol info
Parameter nodeId: Node Id of the device in question
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.isListening, devices[node_id].data.isRouting, devices[node_id].data.optional, devices[node_id].data.sensor1000, devices[node_id].data.sensor250, devices[node_id].data.infoProtocolSpecific

Function Class GetRoutingTableLine

Syntax: GetRoutingTableLine(nodeId, removeBad = FALSE, removeRepeaters = FALSE, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_routing_table_line(ZWay zway, ZWBYTE node_id, ZWBOOL remove_bad, ZWBOOL remove_repeaters, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get routing table line
Parameter nodeId: Node Id of the device in question
Parameter removeBad: Exclude failed nodes from the listing
Parameter removeRepeaters: Exclude repeater nodes from the listing
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.neighbours

Function Class AssignReturnRoute

Syntax: AssignReturnRoute(nodeId, destId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_assign_return_route(ZWay zway, ZWBYTE node_id, ZWBYTE dest_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Assign return route to specified node
Parameter nodeId: Node Id of the device that have to store new route
Parameter destId: Destination Node Id of the route
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class AssignSUCReturnRoute

Syntax: AssignSUCReturnRoute(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_assign_suc_return_route(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Assign return route to SUC
Parameter nodeId: Node Id of the device that have to store route to SUC
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class DeleteReturnRoute

Syntax: DeleteReturnRoute(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_delete_return_route(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Delete return route
Parameter nodeId: Node Id of the device that have to delete all assigned return routes
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class DeleteSUCReturnRoute

Syntax: DeleteSUCReturnRoute(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_delete_suc_return_route(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Delete return route to SUC
Parameter nodeId: Node Id of the device that have to delete route to SUC
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SetDefault

Syntax: SetDefault(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_set_default(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Reset the controller. Note: this function will delete ALL data from the Z-Wave chip and restore it to factory default !. Sticks based on 4.5x and 6.x SDKs will also generate a new Home Id
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: lastExcludedDevice, lastIncludedDevice

Function Class SendSUCNodeId

Syntax: SendSUCNodeId(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_suc_node_id(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Send SUC Node Id. Informs portable and static controllers about new or deleted SUC/SIS
Parameter nodeId: Node Id of the device that have to be informed about new or deleted SIC/SIS
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SendNodeInformation

Syntax: SendNodeInformation(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_node_information(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Send NIF of the stick
Parameter nodeId: Destination Node Id (NODE_BROADCAST to send non-routed broadcast packet)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class RequestNodeInformation

Syntax: RequestNodeInformation(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_request_node_information(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request NIF of a device
Parameter nodeId: Node Id to be requested for a NIF
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.nodeInfoFrame

Function Class RemoveFailedNode

Syntax: RemoveFailedNode(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_remove_failed_node(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Remove failed node from network. Before removing SDK will check that the device is really unreachable
Parameter nodeId: Node Id to be removed from network
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: lastExcludedDevice

Function Class ReplaceFailedNode

Syntax: ReplaceFailedNode(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_replace_failed_node(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Replace failed node with a new one. Be ware that a failed node can be replaced by a node of another type. This can lead to probles!. Always request device NIF and force re-interview after successful replace process
Parameter nodeId: Node Id to be replaced by new one
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: lastIncludedDevice, controllerState

Function Class RequestNetworkUpdate

Syntax: RequestNetworkUpdate(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_request_network_update(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request network topology update from SUC/SIS. Note that this process may also fail due more than 64 changes from last sync. In this case a re-inclusion of the controller (self) is required
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class RequestNodeNeighbourUpdate

Syntax: RequestNodeNeighbourUpdate(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_request_node_neighbour_update(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request neighbours update for specific node
Parameter nodeId: Node Id to be requested for it's neighbours
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: devices[node_id].data.neighbours

Function Class SetLearnMode

Syntax: SetLearnMode(startStop, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_set_learn_mode(ZWay zway, ZWBOOL startStop, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set/stop Learn mode. Tries first classical inclusion then falls back to NWI automatically. Use zway_controller_set_learn_mode instead to get correctly set up the environment after inclusion
Parameter startStop: Start Learn mode if True, stop if False
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class AddNodeToNetwork

Syntax: AddNodeToNetwork(startStop, highPower = TRUE, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_add_node_to_network(ZWay zway, ZWBOOL startStop, ZWBOOL highPower, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Start/stop Inclusion of a new node. Available on primary and inclusion controllers
Parameter startStop: Start inclusion mode if True, stop if False
Parameter highPower: Use full power during this operation if True. On False use low power mode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class SmartStartEnable

Syntax: SmartStartEnable(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_smart_start_enable(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Enable Smart Start mode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class RemoveNodeFromNetwork

Syntax: RemoveNodeFromNetwork(startStop, highPower = FALSE, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_remove_node_from_network(ZWay zway, ZWBOOL startStop, ZWBOOL highPower, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Start/stop exclusion of a node. Note that this function can be used to exclude a device from previous network before including in ours. Available on primary and inclusion controllers
Parameter startStop: Start exclusion mode if True, stop if False
Parameter highPower: Use full power during this operation if True. On False use low power mode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class RemoveNodeIdFromNetwork

Syntax: RemoveNodeIdFromNetwork(nodeId, startStop, highPower = FALSE, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_remove_node_id_from_network(ZWay zway, ZWBYTE nodeId, ZWBOOL startStop, ZWBOOL highPower, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Start/stop exclusion of a node id. Note that this function can be used to exclude a device from previous network before including in ours. Available on primary and inclusion controllers
Parameter nodeId: NodeId to exclude. If 0 or > 232, any node will be excluded (like with zway_fc_remove_node_from_network / RemoveNodeFromNetwork)
Parameter startStop: Start exclusion mode if True, stop if False
Parameter highPower: Use full power during this operation if True. On False use low power mode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class ControllerChange

Syntax: ControllerChange(startStop, highPower = TRUE, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_controller_change(ZWay zway, ZWBOOL startStop, ZWBOOL highPower, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set new primary controller (also known as Controller Shift). Same as Inclusion, but the newly included device will get the role of primary. Available only on primary controller
Parameter startStop: Start controller shift mode if True, stop if False
Parameter highPower: Use full power during this operation if True. On False use low power mode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class CreateNewPrimary

Syntax: CreateNewPrimary(startStop, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_create_new_primary(ZWay zway, ZWBOOL startStop, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Create new primary controller by SUC controller. Same as Inclusion, but the newly included device will get the role of primary. Available only on SUC. Be careful not to create two primary controllers! This can lead to network malfunction!
Parameter startStop: Start create new primary mode if True, stop if False
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: controllerState, lastExcludedDevice, lastIncludedDevice

Function Class ZMEFreqChange

Syntax: ZMEFreqChange(freq, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_freq_change(ZWay zway, ZWBYTE freq, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Change Z-Wave.Me Z-Stick 4 frequency. This function is specific for Z-Wave.Me hardware
Parameter freq: 0x01 RU. 0x02 IN. 0x03 US. 0x04 ANZ. 0x05 HK. 0x06 CN. 0x07 JP. 0x08 KR. 0x09 IL. 0x0A MY. 0xFF request current frequency (ZME firmwares prior to 5.03 don't support this feature)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: frequency

Function Class RFPowerLevelSet

Syntax: RFPowerLevelSet(level, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_rf_power_level_set(ZWay zway, ZWBYTE level, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set RF power level to specified value
Parameter level: 0 to 9
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class RFPowerLevelGet

Syntax: RFPowerLevelGet(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_rf_power_level_get(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get RF power level current value
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SendTestFrame

Syntax: SendTestFrame(nodeId, level, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_send_test_frame(ZWay zway, ZWBYTE node_id, ZWBYTE level, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Send test frame to a node at a specified RF level
Parameter nodeId: Node Id to make test against
Parameter level: 0 to 9
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class FlashAutoProgSet

Syntax: FlashAutoProgSet(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_flash_auto_prog_set(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Put Z-Wave chip in Atuo Prog mode for USB/UART reflashing
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ExploreRequestInclusion

Syntax: ExploreRequestInclusion(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_explore_request_inclusion(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request NWI. Called from SetLearnMode
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ExploreRequestExclusion

Syntax: ExploreRequestExclusion(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_explore_request_exclusion(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Request NWE
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMEBootloaderFlash

Syntax: ZMEBootloaderFlash(seg, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_bootloader_flash(ZWay zway, ZWBYTE seg, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Start reflashing bootloader of Z-Wave.Me firmware for 5th generation Z-Wave chip. This function is specific for Z-Wave.Me hardware
Parameter seg: address of new bootloader location in 2K segments
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMEBootloaderLoadFlash

Syntax: ZMEBootloaderLoadFlash(data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_bootloader_load_flash(ZWay zway, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Load and start reflashing bootloader of Z-Wave.Me firmware for 7th generation Z-Wave chip. This function is specific for Z-Wave.Me hardware
Parameter data: Firmware image data in binary format (use hex2bin to convert from Intel Hex)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMECapabilities

Syntax: ZMECapabilities(data = NULL, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_capabilities(ZWay zway, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get or set firmware capabilities. This function is specific for Z-Wave.Me hardware
Parameter data: data to set (NULL to get)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: caps, uuid

Function Class ZMELicenseSet

Syntax: ZMELicenseSet(data = NULL, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_license_set(ZWay zway, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set Z-Wave.Me firmware capabilities. This function is specific for Z-Wave.Me hardware
Parameter data: data to set (NULL to get)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: caps

Function Class ZMEPHISetLED

Syntax: ZMEPHISetLED(led, status, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephisetled(ZWay zway, ZWBYTE led, ZWBYTE status, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Activate LEDs on Philio hw. This function is specific for Philio hardware
Parameter led: LED id: 0x10 (Logo), 0x11 (Around), 0x12 (Misc)
Parameter status: LED status 2 (Off), 4 (On), 8 (Flash), 16 (Slow flash), 32 (Slow dimming)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMEPHIGetButton

Syntax: ZMEPHIGetButton(button, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephigetbutton(ZWay zway, ZWBYTE button, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get button state on Philio hw. This function is specific for Philio hardware
Parameter button: 0: Tamper Key, 1: Function Key A, 2: Function Key B
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: philiohw.tamper, philiohw.funcA, philiohw.funcB

Function Class ZMEPHIGetPower

Syntax: ZMEPHIGetPower(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephigetpower(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get power state on Philio hw. This function is specific for Philio hardware
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: philiohw.powerFail, philiohw.batteryLevel, philiohw.charging, philiohw.batteryFail

Function Class ZMEPHIGetBattery

Syntax: ZMEPHIGetBattery(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephigetbattery(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get battery state on Philio hw. This function is specific for Philio hardware
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: philiohw.batteryADCLevel

Function Class ZMEPHIGetRTC

Syntax: ZMEPHIGetRTC(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephigetrtc(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get RTC from Philio hw. This function is specific for Philio hardware
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Report: set system time

Function Class ZMEPHISetRTC

Syntax: ZMEPHISetRTC(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zmephisetrtc(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set RTC on Philio hw. This function is specific for Philio hardware
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class InjectPacket

Syntax: InjectPacket(nodeId, data, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_application_command_handler_inject(ZWay zway, ZWBYTE node_id, const ZWBYTE * data, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Inject command in Z-Way as it was received via Z-Wave. This function is for debugging only
Parameter nodeId: Source Node Id
Parameter data: Paket payload (should looks like ccId, ccCmd, data, ....)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class GetBackgroundRSSI

Syntax: GetBackgroundRSSI(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_background_rssi(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get background noise level
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SerialAPISetupSetIMA

Syntax: SerialAPISetupSetIMA(enable, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_setup_set_ima(ZWay zway, ZWBOOL enable, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Enable Advanced IMA in Z-Wave.Me firmware
Parameter enable: Set feature state: True to enable, False to disable
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SerialAPISetupSetTxPower

Syntax: SerialAPISetupSetTxPower(power, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_serial_api_setup_set_tx_power(ZWay zway, ZWBYTE power, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set Tx power in Z-Wave.Me firmware
Parameter power: Power level in 10*dBm
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ClearNetworkStats

Syntax: ClearNetworkStats(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_clear_network_stats(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Clear statistics gathered by the Z-Wave protocol
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class GetNetworkStats

Syntax: GetNetworkStats(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_network_stats(ZWay zway, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get statistics gathered by the Z-Wave protocol
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class GetPriorityRoute

Syntax: GetPriorityRoute(nodeId, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_get_priority_route(ZWay zway, ZWBYTE node_id, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Get the route with the highest priority
Parameter nodeId: Node ID we are interested in
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SetPriorityRoute

Syntax: SetPriorityRoute(nodeId, repeater1, repeater2, repeater3, repeater4, routeSpeed, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_set_priority_route(ZWay zway, ZWBYTE node_id, ZWBYTE repeater1, ZWBYTE repeater2, ZWBYTE repeater3, ZWBYTE repeater4, ZWBYTE route_speed, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set the route with the highest priority
Parameter nodeId: Node ID we are interested in
Parameter repeater1: Hop #1 in the route. Value 0 means direct range. Values > 232 clears the priority route and LWR (Last Working Route is selected by the protocol)
Parameter repeater2: Hop #2 in the route. Value 0 means end of route
Parameter repeater3: Hop #3 in the route. Value 0 means end of route
Parameter repeater4: Hop #4 in the route. Value 0 means end of route
Parameter routeSpeed: Baudrate to use: 1 for 9.6 kbps, 2 for 40 kbps, 3 for 100 kbps
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class SetPromiscuousMode

Syntax: SetPromiscuousMode(enable, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_set_promiscuous_mode(ZWay zway, ZWBOOL enable, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Enable or disable promiscuous mode
Parameter enable: True to enable functionality, False to disable
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class AssignPriorityReturnRoute

Syntax: AssignPriorityReturnRoute(nodeId, destId, repeater1, repeater2, repeater3, repeater4, routeSpeed, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_assign_priority_return_route(ZWay zway, ZWBYTE node_id, ZWBYTE dest_id, ZWBYTE repeater1, ZWBYTE repeater2, ZWBYTE repeater3, ZWBYTE repeater4, ZWBYTE route_speed, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Assign priority return route to specified node
Parameter nodeId: Node Id of the device that have to store new route
Parameter destId: Destination Node Id of the route
Parameter repeater1: Hop #1 in the route. Value 0 means direct range
Parameter repeater2: Hop #2 in the route. Value 0 means end of route
Parameter repeater3: Hop #3 in the route. Value 0 means end of route
Parameter repeater4: Hop #4 in the route. Value 0 means end of route
Parameter routeSpeed: Baudrate to use: 1 for 9.6 kbps, 2 for 40 kbps, 3 for 100 kbps
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class AssignPrioritySUCReturnRoute

Syntax: AssignPrioritySUCReturnRoute(nodeId, repeater1, repeater2, repeater3, repeater4, routeSpeed, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_assign_priority_suc_return_route(ZWay zway, ZWBYTE node_id, ZWBYTE repeater1, ZWBYTE repeater2, ZWBYTE repeater3, ZWBYTE repeater4, ZWBYTE route_speed, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Assign priority return route to SUC
Parameter nodeId: Node Id of the device that have to store route to SUC
Parameter repeater1: Hop #1 in the route. Value 0 means direct range
Parameter repeater2: Hop #2 in the route. Value 0 means end of route
Parameter repeater3: Hop #3 in the route. Value 0 means end of route
Parameter repeater4: Hop #4 in the route. Value 0 means end of route
Parameter routeSpeed: Baudrate to use: 1 for 9.6 kbps, 2 for 40 kbps, 3 for 100 kbps
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMESerialAPIOptionsJammingDetectionSet

Syntax: ZMESerialAPIOptionsJammingDetectionSet(ch1Threshold, ch2Threshold, ch3Threshold, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_serialapi_options_jamming_detection_set(ZWay zway, ZWBYTE ch1_threshold, ZWBYTE ch2_threshold, ZWBYTE ch3_threshold, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set Jamming Detection threshold. Jamming detection fine tuning in NVM:. address 6530, 3 bytes: ch1_threshold ch2_threshold ch3_threshold. address 6533, 2 bytes: how many times should measurements exceed in last 10 seconds to trigger the alarm, default 2 times. address 6535, 2 bytes: repeat the alarm in N*0.1 seconds if the jamming persists, default 0100 = 25.6 sec
Parameter ch1Threshold: Threshold for channel 1
Parameter ch2Threshold: Threshold for channel 2
Parameter ch3Threshold: Threshold for channel 3
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMESerialAPIOptionsAdvancedIMASet

Syntax: ZMESerialAPIOptionsAdvancedIMASet(enable, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_serialapi_options_advanced_ima_set(ZWay zway, ZWBOOL enable, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Enable/disable advanced IMA by Z-Wave.Me that includes incoming route path information
Parameter enable: Turn on or off
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMESerialAPIOptionsStaticAPISet

Syntax: ZMESerialAPIOptionsStaticAPISet(enable, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_serialapi_options_static_api_set(ZWay zway, ZWBOOL enable, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Switch between Static and Bridge API for Z-Wave.Me firmware
Parameter enable: Turn on or off Static API
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed

Function Class ZMESerialAPIOptionsUARTSpeedSet

Syntax: ZMESerialAPIOptionsUARTSpeedSet(speed = 115200, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zway_fc_zme_serialapi_options_uart_speed_set(ZWay zway, speed_t speed, ZJobCustomCallback successCallback, ZJobCustomCallback failureCallback, void* callbackArg)
Description: Set high speed for UART interface for Z-Wave.Me firmware
Parameter speed: UART speed. Valid values are listed in UART_SPEEDS macro definition
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed