Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration

Data

Description

Required

type

OCTOPRINT

The machine's interface type.

url

http://192.168.1.41:5000

The individual machine's interface url.

custom_name

my_octoprint_machine

The custom machine name to be displayed in the Agile MES.

authentication_file_path

secret.txt or JSON string

File containing API key. For files, the path can be absolute or relative to the Aggregator.

mes_id

[1]

The MES instance(s) of your organization.

...

Code Block
languagejson
{
  "type": "OCTOPRINT",
  "url": "http://192.168.1.41:5000",
  "custom_name": "my_octoprint_machine",
  "authentication_file_path": "secret.txt", // contents as shown below without ""
  "mes_id": [
    1
  ]
}

OR

Code Block
languagejson
{
  "type": "OCTOPRINT",
  "url": "http://192.168.1.41:5000",
  "custom_name": "my_octoprint_machine",
  "authentication_file_path": "A0A00B123E454H122BD513FE58B5E9BC",
  "mes_id": [
    1
  ]
}

Secret:

Info

Starting from version 1.4, you can also inline the contents of your secret file in the in the authentication_file_path field

Simply copy the Apikey into a secret.txt file. Set the file name in the authentication_file_path field in your config.json file.

Example content:

Code Block
A0A00B123E454H122BD513FE58B5E9BC

Aggregator version 1.2 - 1.3

...

Code Block
languagejson
{
  "type": "OCTOPRINT",
  "url": "http://192.168.1.41:5000",
  "custom_name": "my_octoprint_machine",
  "authentication_file_path": "secret.txt",
  "mes_id": [
    1
  ]
}

Secret:

Simply copy the Apikey into a secret.txt file. Set the file name in the authentication_file_path field in your config.json file.

...

Code Block
languagejson
{
  "type": "OCTOPRINT",
  "url": "http://192.168.1.41:5000",
  "api_key": "A0A00B123E454H122BD513FE58B5E9BC",
  "mes_id": [
    1
  ]
}

Secret:

Directly copy the API key in the config.json field api_key.

...