CK-InoDrive-API 0.2.8b0

InoDrive API library

Installation

pip install CK-InoDrive-API

Usage

Import

# Import InoDrive API library
import CkInoDriveAPI

Create InoDrive Object instance over WebSocket connection.

# Connect by Module Name
drive = CkInoDriveAPI.InoDrive(target='Name')
# Connect by Module Serial Number
drive = CkInoDriveAPI.InoDrive(target='SN')
# Connect by IP Address
drive = CkInoDriveAPI.InoDrive(target='IPv4 Address')
# Optional parameter to have Module automatically connect upon creation
drive = CkInoDriveAPI.InoDrive(target='IPv4 Address', autoConnect=True)

Get Discovery Information from Module.

# Connect by Module Name
drive = CkInoDriveAPI.InoDrive(target='Name')

# Get Discovery Information
discoverInfo = drive.get_discover_info()

# Disconnect from the drive
drive.disconnect()
# Drive object cleanup
drive.dispose()

Read variable from the Module and based on condition write a variable back.

# Create InoDrive instance by Module Serial Number and connect
drive = CkInoDriveAPI.InoDrive(target='SN', autoConnect=True)
# Read variable with name 'VariableName'
var1 = drive.read_var('VariableName')

# Write out new value to variable 'VariableName' if it's value equals 1
if var1 == 1:
	drive.write_var('VariableName', 2)
	
# Disconnect from the drive
drive.disconnect()
# Drive object cleanup
drive.dispose()

Read the Module configuration file and change it's Name. Change takes effect after power cycle.

# Create InoDrive instance by Module Serial Number and connect
drive = CkInoDriveAPI.InoDrive(target='SN', autoConnect=True)

# Get Module Configuration File
content = drive.read_module_config()

# Change Module Name
content['name'] = "NewName"

#Write Out to Configuration File
drive.write_module_config(content)

# Disconnect from the drive
drive.disconnect()
# Drive object cleanup
drive.dispose()