Skip to main content

Gaia Python Client

This project introduces thin client for JOT Gaia HTTP API written on python. See API description bellow. Usage of the client is described on example.py.

Installation

Preferred way to install is to use pip pip install gaiaclient

JOT Gaia HTTP API quick start

Gaia Machines

What it is?

Low-ceremony, simple and self-assisting HATEOAS RestFul API for controlling JOT Automation Gaia platform testers.

Browse the API

Use any web browser to browse through the API. Responses are in a JSON format so if your browser doesn't pretty print JSON automatically, you may want to install an extension that will do it for you. And yes everything you can do with the API is readable from the API itself.

Gaia API follows Siren with some additions.

API is found from address [URL]/api, where URL is URL to your gaia machine or virtual gaia instance.

Applications

Every piece of hardware you want to control is an application. To list applications make GET request to URL/api/applications. You will get list of entities i.e. applications. To get more information about the application make GET request to "href". Now you will get all information about the application. To control the application see list of actions on response.

When you need to change state of entity (remember action is an entity), run robot movement or execute any other action, you need to find action field of the entity. Every action has the same structure.

Action defines always:

  • name (name is unique in the context of the gaia machine)
  • href (URL of the action)
  • fields (see bellow)
  • type (content type, almost always application/json)
  • method (POST or GET)
  • title (Description of what the action does)

If there is limited amount of options on fields they all are listed.

Here I will list some applications types. This is not a comprehensive list of applications. The API itself will guide you to control any type of application and if you need assistance we are happy to help you.

Stateful applications

Stateful application is type of application that defines limited number of states. In most cases there is two states: work/home, open/close etc.

CNC robot

CNC robot application is type of application that is able to execute robot movements defined as G-code.

Stateful application action example

Here is an example of a stateful application action (Snip from GET http://URL/api/applications/BatteryConnector response)

{
  "type": "application/json",
  "href": "http://URL/api/applications/BatteryConnector/state",
  "requiredActions": {},
  "method": "POST",
  "stateConditions": {},
  "title": "Trigger state change to Home",
  "name": "set-Home",
  "fields": [
              {
                "type": "text",
                "name": "value",
                "value": "Home"
               }
            ]
}

As you see there is some additional fields compared to standard action response. Those are used mainly for UI and can be omitted now. We are mainly interested on fields. To "trigger state change to Home"(title) you need to POST(method) to URL(href) with JSON(type) body containing field (fields) that has name "value" with value "Home". The whole command with cURL tool:

curl -X POST -H "Content-Type: application/json" -d '{"value":"Work"}' http://URL/api/applications/BatteryConnector/state

CNC robot application

Here is an example of a cnc application action (Snip from GET http://URL/api/applications/MainRobot response)

{
  "title": "Execute CNC/G-code run",
  "href": "http://URL/api/applications/MainRobot/cnc_run",
  "type": "text/plain",
  "method": "POST",
  "name": "cnc_run",
  "fields": [
              {
              "type": "text",
              "name": "G-code"
              }
            ]
}

To "execute CNC/G-code run"(title) you need to POST(method) to URL(href) with text/plain(type) body containing G-code. The whole command with cURL tool:

curl -X POST -H "Content-Type: text/plain" -d 'N010 G01 X133.964 Y41.984 Z73.5' http://URL/api/applications/MainRobot/cnc_run

This example contains only one line of G-code. Real G-codes are of course longer. Whole G-code is sent as is with linux line endings.

Tool to use with G-code can be set with comment line before real G-code starts. Syntax is "(ToolToUse:Finger1)" without quotes.

State actions

State actions do change state of main state machine. State actions are found from http://URL/api.

Blocked actions vs actions

If it is not allowed to execute the action, the action is listed under blocked actions instead of actions.

Client examples

We have created free open-source clients to help the integration work. Find clients with example code here:

Tips to create your own client

Keep it simple. As you can see from our examples we don't define application or action types on client side. Instead we call applications and actions by name. This way client side is super thin and still capable of controlling any application. Thus you don't need to introduce new application type on client side when new application type is introduced on server side.

Metadata

Release files for gaiaclient 1.7.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gaiaclient 1.7.10
File Size Uploaded Provenance Actions
gaiaclient-1.7.10.tar.gz 7.5 kB Without provenance Details for gaiaclient-1.7.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gaiaclient 1.7.10
File Interpreter ABI Platform Actions
gaiaclient-1.7.10-py2-none-any.whl Python 2 none any Details for gaiaclient-1.7.10-py2-none-any.whl

Total release size: 15.7 kB

Release files / gaiaclient-1.7.10.tar.gz

Download URL gaiaclient-1.7.10.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b8f6d25bd664f206c5f3c448ad6624c2a1dc4ba765824acb3a66ff329bdd38f8
BLAKE2b-256 checksum
How to use checksums
ef8dc4cbea4410ddcbaef42f5ef5db66ae9977f84dbaea5b343d187b805b5fdd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.8.0 requests/2.26.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/2.7.12

Release files / gaiaclient-1.7.10-py2-none-any.whl

Download URL gaiaclient-1.7.10-py2-none-any.whl
Size 8.2 kB
Tags Python 2
SHA-256 checksum
How to use checksums
76e3166f60020355b6b5de8093d8fcd5322c654dd00e3ac47c6896e429843c6c
BLAKE2b-256 checksum
How to use checksums
5ad7439a90d32757fd7ef3e1f4d9bec8f3263698c63ac29226c695077ddef225
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.8.0 requests/2.26.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/2.7.12

Security for gaiaclient 1.7.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.7.10 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page