Skip to main content

AOI API

Project description

AOI-API

AOI_API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.1
  • Package version: 1.0.1
  • Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import AOI_API

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import AOI_API

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import AOI_API
from AOI_API.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/AOIServer
# See configuration.py for a list of all supported configuration parameters.
configuration = AOI_API.Configuration(
    host = "http://localhost/AOIServer"
)



# Enter a context with an instance of the API client
with AOI_API.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = AOI_API.AOIApi(api_client)
    board_width = 3.4 # float | width of board to be scanned (optional)
board_length = 3.4 # float | length of board to be scanned (optional)
step_size = 3.4 # float | step size between images (optional)

    try:
        # 
        api_instance.post_scan_board(board_width=board_width, board_length=board_length, step_size=step_size)
    except ApiException as e:
        print("Exception when calling AOIApi->post_scan_board: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to http://localhost/AOIServer

Class Method HTTP request Description
AOIApi post_scan_board POST /scan_board
AOIApi put_calibration PUT /calibrate

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

corey.sadler@3adesign.co.uk

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

aoi_package-2.0.1.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

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

aoi_package-2.0.1-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file aoi_package-2.0.1.tar.gz.

File metadata

  • Download URL: aoi_package-2.0.1.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for aoi_package-2.0.1.tar.gz
Algorithm Hash digest
SHA256 ac0c7663c0fd986a33ef119f4ccd8daaf8043e5a566a88e6f5936d9fa080fc98
MD5 8f5c45749d2c6f2136e14eefb7540853
BLAKE2b-256 3e53dba6449df00fdb267994eec568d96b6e18790f8c33df58ae7fceffe2a1d6

See more details on using hashes here.

File details

Details for the file aoi_package-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: aoi_package-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for aoi_package-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4a02400a18626ee51d8356fce44f59c8bdfedd794458e77940fcfcaf189e24e
MD5 02de4d5c1f6c44e9d9ea0527147d12ad
BLAKE2b-256 55fd37beb0139f951a94da056d4553d731fae45190784c5139fec67661508a18

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