Skip to main content

ADAM 6050-D REST API Python Wrapper

Project description

ADAM 6050-D REST API Implementation

Documentation Status Tests Publish

image

ADAM 6000-Series Manual

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adam_io-0.1.1153.1150.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adam_io-0.1.1153.1150-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file adam_io-0.1.1153.1150.tar.gz.

File metadata

  • Download URL: adam_io-0.1.1153.1150.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for adam_io-0.1.1153.1150.tar.gz
Algorithm Hash digest
SHA256 e83aeab23a774d915c01434243d41215a36391d486497477edf11f4d93e855b3
MD5 86bebb92fc8c9d14877b1bdc32976465
BLAKE2b-256 8770b8e41e6094ae9efbd210d1d70922f1ce62dcbf42366dd4b088083e4446bb

See more details on using hashes here.

File details

Details for the file adam_io-0.1.1153.1150-py3-none-any.whl.

File metadata

  • Download URL: adam_io-0.1.1153.1150-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for adam_io-0.1.1153.1150-py3-none-any.whl
Algorithm Hash digest
SHA256 39304c2ed0bf1b4684a6dbb063e8dee3b8f813e86778816c787b04c1c4def46d
MD5 44a690a5abc56ad2fe228ab074e37686
BLAKE2b-256 2f547f58b07e0df12f6aaa2f8f4a36df3f1c70e6ee19d6524cdfca11ab8b391e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page