Versions Compared

Key

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

...

  • Dashboard credentials:
    Set username and password upon account creation at https://formlabs.com/ .

  • Developer API credentials:
    Obtain client_id and client_secret by contacting Formlabs at gtl@formlabs.com.

Secret file example:

For OAuth authentication you will have to create a file similar to the one below and adjust the authentication_file_path in your config.json.

Code Block
languagejson
{
   "username":"USERNAME",
   "password":"PASSWORD",
   "client_id":"CLIENT_ID",
   "client_secret":"CLIENT_SECRET"
}

Aggregator version 1.4

Configuration

Data

Description

Required

type

FORMLABS

The machine's interface type.

url

https://api.formlabs.com

Formlabs api base url.

custom_name

my_formlabs_machine

The custom machine name to be displayed in the Agile MES. Will be read from the machine if unset.

unique_name

MyPrinter

The serial number of the machine.

authentication_file_path

./secret.json

A secrets file for OAuth authentication (see below). Path can be absolute or relative to the Aggregator.

mes_id

[1]

The MES instance(s) of your organization.

...

Code Block
languagejson
{
   "type":"FORMLABS",
   "url":"https://api.formlabs.com",
   "custom_name":"my_formlabs_machine",
   "unique_name":"MyPrinter",
   "authentication_file_path":"./secret.json",
   "mes_id":[
      1
   ]
}

OR

Code Block
languagejson
{
   "type":"FORMLABS",
   "url":"https://api.formlabs.com",
   "custom_name":"my_formlabs_machine",
   "unique_name":"MyPrinter",
   "authentication_file_path":
   {
      "username":"USERNAME",
      "password":"PASSWORD",
      "client_id":"CLIENT_ID",
      "client_secret":"CLIENT_SECRET"
   },
   "mes_id":[
      1
   ]
}

Secret example:

Info

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

For OAuth authentication you will have to create a file similar to the one below and adjust the authentication_file_path in your config.json.

Code Block
languagejson
{
   "username":"USERNAME",
   "password":"PASSWORD",
   "client_id":"CLIENT_ID",
   "client_secret":"CLIENT_SECRET"
}

Aggregator version 1.3

Configuration

Data

Description

Required

type

FORMLABS

The machine's interface type.

url

https://api.formlabs.com

Formlabs api base url.

custom_name

my_formlabs_machine

The custom machine name to be displayed in the Agile MES. Will be read from the machine if unset.

unique_name

MyPrinter

The serial number of the machine.

authentication_file_path

./secret.json

A secrets file for OAuth authentication (see below). Path can be absolute or relative to the Aggregator.

mes_id

[1]

The MES instance(s) of your organization.

umati_server_port

4840+

Umati server port used for internal data transfer. Set if the default port is conflicting with another port on your server.

...

Code Block
languagejson
{
   "type":"FORMLABS",
   "url":"https://api.formlabs.com",
   "custom_name":"my_formlabs_machine",
   "unique_name":"MyPrinter",
   "authentication_file_path":"./secret.json",
   "mes_id":[
      1
   ]
}

Secret file example:

For OAuth authentication you will have to create a file similar to the one below and adjust the authentication_file_path in your config.json.

Code Block
languagejson
{
   "username":"USERNAME",
   "password":"PASSWORD",
   "client_id":"CLIENT_ID",
   "client_secret":"CLIENT_SECRET"
}