ADAM 6050-D REST API Python Wrapper
Project description
ADAM 6050-D REST API Implementation
6050-D has 12 digital inputs and 6 digital outputs. It can be controlled with http requests. The aim of this repo is to wrap the ADAM API into a convenience module for Event Gates' deep learning platform VIS.
Installation
pip install adam-io
Usage Examples
You can update output state in three steps;
- Create the ADAM object
- Create/reuse DigitalOutput
- Call ADAM’s output method with DigitalOutput
Read the input state;
- Call ADAM’s input method
Create adam object
IP, username, password of ADAM should be already set from APEX
from adam import ADAM6050D as ADAM
ip='192.168.1.1'
username = 'user'
password = 'pass'
adam = ADAM(ip, username, password)
Construct the digital output object
To change the state of the outputs, you should create/reuse a DigitalOutput object After creating the object, the initial state is empty, so making a request straight away changes nothing.
from digital_io import DigitalOutput
do = DigitalOutput()
# set every available output to 1
do[0]=1
do[1]=1
do[2]=1
do[3]=1
do[4]=1
do[5]=1
You don’t have to set every bit, you can just change the ones you need.
from digital_io import DigitalOutput
do = DigitalOutput()
# set DO0 to 1 and DO5 to 0
do[0]=1
do[5]=0
DigitalOutput accepts an array to set the outputs all at once
from digital_io import DigitalOutput
# set every available output to 1
initial_array = [1,1,1,1,1,1,1]
do = DigitalOutput(array=initial_array)
Change the state
After creating adam and setting the digital outputs, make the request by calling the output method of ADAM and pass the digitalOuput object as argument.
from adam import ADAM6050D as ADAM
from digital_io import DigitalOutput
ip='192.168.1.1'
username = 'user'
password = 'pass'
adam = ADAM(ip, username, password)
do = DigitalOutput()
# set DO0 to 1 and DO5 to 0
do[0]=1
do[5]=0
# request the state change
try:
adam.output(do)
except Exception as err:
print(err)
Read the state of output
You can get the current state by calling the digitalOutput object without an argument
current_output = adam.output()
# state of DO0
current_output[0]
Read the state of input
To read the input state, call input() on ADAM. You can pass in the id of a specific input if you want. Otherwise every input value is retrieved
input_id = 0
di_0 = adam.input(input_id)
# value of DI0
print(di_0)
di = adam.input(input_id)
# digital inputs
print(di[0]) # DI0
print(di[1]) # DI1
#
#
#
print(di[10]) # DI10
print(di[11]) # DI11
LICENSE
MIT License
Copyright (c) 2020 Event Gates
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file adam_io-1.1608563019.8183098.tar.gz
.
File metadata
- Download URL: adam_io-1.1608563019.8183098.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f0ff70a4151ed874990c6dec8bc6cbe924086acffa1a4474f022d082363910d |
|
MD5 | be5a8667ac8d496d4b3045b3cdb2cc85 |
|
BLAKE2b-256 | 8a0ef5c6f792a53060fe3e1226bd393fef74bf7ef4ec06f560f7a93a24596aff |
File details
Details for the file adam_io-1.1608563019.8183098-py3-none-any.whl
.
File metadata
- Download URL: adam_io-1.1608563019.8183098-py3-none-any.whl
- Upload date:
- Size: 8.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1e51790e8436b78a3a79069852830a88b8a64f7bb927c40bb53699606a81bd |
|
MD5 | 52936c39e8e6d9032e6745e8db36b83b |
|
BLAKE2b-256 | e5c858410e4f359a17c91fe5b7e99d845ba3e93db583ed4e8ff1b6ade11b755f |