#### **Installation**
Install and Update package via [pip](https://pip.pypa.io/en/stable/getting-started/)
```
pip install CK-InoDrive-API
```
#### **Usage**
Importing Library
```python
# Import InoDrive API library
import CkInoDriveAPI
```
Create InoDrive Object using WebSocket
```python
# Create instance to InoDrive module object
# Connect by Name
Drive = CkInoDriveAPI.InoDrive(target='Name')
# Connect by Serial Number
Drive = CkInoDriveAPI.InoDrive(target='SN')
# Connect by IP Address
Drive = CkInoDriveAPI.InoDrive(target='IPv4 Address')
# Auto connect
Drive = CkInoDriveAPI.InoDrive(target='IPv4 Address', autoConnect=True)
```
Read and Write Variable's
```python
# Connect to the drive
Drive.connect()
# Read variable with name 'VariableName'
Drive.UserApp.read_var('VariableName')
# Write variable with name 'VariableName' and value equal to 1
Drive.UserApp.write_var('VariableName', 1)
# Disconnect from the drive
Drive.disconnect()
# Drive object cleanup
Drive.dispose()
```
Get and Set Output's
```python
# Connect to the drive
Drive.connect()
# Read Output 2
state = Drive.IO.get_output(2)
# Take control of InoDrive module to override output state
Drive.SysControl.take_control(True)
# Set Output 2 to On state
Drive.IO.set_output(2, True)
state = Drive.IO.get_output(2)
# Disable module override
Drive.SysControl.take_control(False)
# Disconnect from the drive
Drive.disconnect()
# Drive object cleanup
Drive.dispose()
```
Change Module Name (Power cycle InoDrive for changes to take effect)
```python
# Connect to the drive
Drive.connect()
# Read module configuration file
config_file = Drive.File.read_module_config()
# Set new module name
config_file['name'] = "NewName"
# Write configuration changes out
Drive.File.write_module_config(config_file)
# Disconnect from the drive
Drive.disconnect()
# Drive object cleanup
Drive.dispose()
```
#### **Links**
- [API Documentation](https://www.cardinalkinetic.com/user-manual/api/inodrive-py)
- [Company Website](https://www.cardinalkinetic.com)
Raw data
{
"_id": null,
"home_page": "https://cardinalkinetic.com",
"name": "CK-InoDrive-API",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "InoWorx InoDrive InoSync MotionControl ServoControl",
"author": "Cardinal Kinetic",
"author_email": "support@cardinalkinetic.com",
"download_url": "https://files.pythonhosted.org/packages/bf/97/c8dd0173335e68a531a8433f8a4aaf980f7fd127d78597eec08fd3b3639b/CK-InoDrive-API-0.2.9.tar.gz",
"platform": null,
"description": "#### **Installation**\r\n\r\nInstall and Update package via [pip](https://pip.pypa.io/en/stable/getting-started/)\r\n\r\n```\r\npip install CK-InoDrive-API\r\n```\r\n\r\n#### **Usage**\r\n\r\nImporting Library\r\n\r\n```python\r\n# Import InoDrive API library\r\nimport CkInoDriveAPI\r\n```\r\n\r\nCreate InoDrive Object using WebSocket\r\n\r\n```python\r\n# Create instance to InoDrive module object\r\n# Connect by Name\r\nDrive = CkInoDriveAPI.InoDrive(target='Name')\r\n\r\n# Connect by Serial Number\r\nDrive = CkInoDriveAPI.InoDrive(target='SN')\r\n\r\n# Connect by IP Address\r\nDrive = CkInoDriveAPI.InoDrive(target='IPv4 Address')\r\n\r\n# Auto connect\r\nDrive = CkInoDriveAPI.InoDrive(target='IPv4 Address', autoConnect=True)\r\n```\r\n\r\nRead and Write Variable's\r\n\r\n```python\r\n# Connect to the drive\r\nDrive.connect()\r\n\r\n# Read variable with name 'VariableName'\r\nDrive.UserApp.read_var('VariableName')\r\n\r\n# Write variable with name 'VariableName' and value equal to 1\r\nDrive.UserApp.write_var('VariableName', 1)\r\n\r\n# Disconnect from the drive\r\nDrive.disconnect()\r\n\r\n# Drive object cleanup\r\nDrive.dispose()\r\n```\r\n\r\nGet and Set Output's\r\n\r\n```python\r\n# Connect to the drive\r\nDrive.connect()\r\n\r\n# Read Output 2\r\nstate = Drive.IO.get_output(2)\r\n\r\n# Take control of InoDrive module to override output state\r\nDrive.SysControl.take_control(True)\r\n\r\n# Set Output 2 to On state\r\nDrive.IO.set_output(2, True)\r\nstate = Drive.IO.get_output(2)\r\n\r\n# Disable module override\r\nDrive.SysControl.take_control(False)\r\n\r\n# Disconnect from the drive\r\nDrive.disconnect()\r\n\r\n# Drive object cleanup\r\nDrive.dispose()\r\n```\r\n\r\nChange Module Name (Power cycle InoDrive for changes to take effect)\r\n\r\n```python\r\n# Connect to the drive\r\nDrive.connect()\r\n\r\n# Read module configuration file\r\nconfig_file = Drive.File.read_module_config()\r\n\r\n# Set new module name\r\nconfig_file['name'] = \"NewName\"\r\n\r\n# Write configuration changes out\r\nDrive.File.write_module_config(config_file)\r\n\r\n# Disconnect from the drive\r\nDrive.disconnect()\r\n\r\n# Drive object cleanup\r\nDrive.dispose()\r\n```\r\n\r\n#### **Links**\r\n\r\n- [API Documentation](https://www.cardinalkinetic.com/user-manual/api/inodrive-py)\r\n- [Company Website](https://www.cardinalkinetic.com)\r\n",
"bugtrack_url": null,
"license": "https://www.cardinalkinetic.com/user-manual/api/inodrive-py",
"summary": "InoDrive API Library",
"version": "0.2.9",
"project_urls": {
"Documentation": "https://www.cardinalkinetic.com/user-manual/api/inodrive-py",
"Homepage": "https://cardinalkinetic.com"
},
"split_keywords": [
"inoworx",
"inodrive",
"inosync",
"motioncontrol",
"servocontrol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac6259cbd65cf70bb478baccf8fe3e1e9c5bb0fb1f020b9025131281bd793e1c",
"md5": "a1a2e2e78135bdb93f064cd504c30cc2",
"sha256": "095888a4fe3f1e2365e9ba32534478e747fcad13b0e96fcd0d777770457f801e"
},
"downloads": -1,
"filename": "CK_InoDrive_API-0.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1a2e2e78135bdb93f064cd504c30cc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 48546,
"upload_time": "2024-03-20T15:40:51",
"upload_time_iso_8601": "2024-03-20T15:40:51.390479Z",
"url": "https://files.pythonhosted.org/packages/ac/62/59cbd65cf70bb478baccf8fe3e1e9c5bb0fb1f020b9025131281bd793e1c/CK_InoDrive_API-0.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf97c8dd0173335e68a531a8433f8a4aaf980f7fd127d78597eec08fd3b3639b",
"md5": "b149458220c37b3be989d6f41ab01626",
"sha256": "d92105556e1047d16cf43f06b3bfb410d6227d6d2fcc8f4f6b9a427ac4062503"
},
"downloads": -1,
"filename": "CK-InoDrive-API-0.2.9.tar.gz",
"has_sig": false,
"md5_digest": "b149458220c37b3be989d6f41ab01626",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44769,
"upload_time": "2024-03-20T15:40:52",
"upload_time_iso_8601": "2024-03-20T15:40:52.500578Z",
"url": "https://files.pythonhosted.org/packages/bf/97/c8dd0173335e68a531a8433f8a4aaf980f7fd127d78597eec08fd3b3639b/CK-InoDrive-API-0.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 15:40:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ck-inodrive-api"
}
JSON