This guide describes how to set up 3YOURMIND’s machine connectivity.
Table of Contents |
---|
Prerequisites
Check which machines are currently supported.
Assure that the machines are connected to the network. (LAN / WLAN)
3YOURMIND’s Aggregator must be downloaded and available in the network.
Access to 3YOURMIND’s Agile MES Admin and Service Panel. (minimum of version 3.14)
Assure that all system requirements are met.
Tip |
---|
Steps to connect machines:
|
1. Obtaining IP address and port
Ultimaker
On the onboard UI of the machine go to System → Network → Connection Status to obtain the IP address and port.
BigRep
On the onboard UI of the machine click on the Settings button in the top right corner of the screen. Click on Printer information to see the IP address and port. Also refer to section two in this BigRep support article.
Formlabs
See the Installation And Usage Instructions manual that came with your machine on how to connect it to the internet.
Create an account on https://formlabs.com and follow the instructions to register the machine with your account.
Carbon3D
Make sure the machine has access to the internet.
Contact Carbon3D to create an account for https://print.carbon3d.com/users/sign_in.
EOS
Access the machine's API documentation at https://si2381/api, replace si2381 with the actual ID of the machine. Navigate to the OPC UA Documentation and look for the Endpoint URL.
HP
Either:
Obtain the IP address of the device that is running the HP SmartStream 3D Command Center Server and append the port
8443
.
Or:
Install the HP SmartStream 3D Command Center Client which is able to detect Command Center Servers within the network. The hostname/IP address can be found in the Network connectivity tab.
2. Machine specific connection information
Certain machines require additional information before they can be connected. The highlighted
values mentioned below are needed for the configuration of the Aggregator.
Ultimaker
Option 1:
On the onboard UI of the machine go to System → Network → Connection Status to get the printer name. You will need to enter this name as the
unique_name
during Aggregator configuration.
Option 2:
Navigate to
http://[IP address]:[port]/api/v1/system/hostname
in a web browser.
Tip |
---|
Example: |
Octoprint/BigRep
Navigate to the URL of the machine in a web browser, this should bring up the OctoPrint Settings.
Obtain either the global api key or a user bound api key:
Click on Api in the left menu and note the
Apikey
.Click on Access Control, create a new user or note the
Apikey
of an existing one that has at least STATUS permissions.
Formlabs Rest API
Obtain developer API credentials in the form of
client_id
andclient_secret
by contacting Formlabs at gtl@formlabs.com.Note the
username
andpassword
of your https://formlabs.com account.
Carbon3D Rest API
Generate an API Key at https://print.carbon3d.com/api_keys by clicking the Create API Key button. This will automatically download a
secret.json
file.
OPC UA/EOSCONNECT Core
Obtain
username
andpassword
at https://si2381/gui/auth, replace si2381 with the actual ID of the machine. This page is secured with a login and you will need to use your EOScada credentials to access it. Only EOScada credentials that have the role of Supervisor can add new clients.
MT Connect Stratasys
No specific information is needed.
HP
Reach out to HP to obtain the Gateway API credentials (user and secret). They come in two files: deviceproxy.json that must be installed into the HP SmartStream 3D Command Center Server and a
credentials.json
that must be provided to the Aggregator. For installation into the server see the section Installing Gateway Credentials.
3. Obtain API Token and Agile MES Service ID
API Token
Info |
---|
This step can be done by anyone with access to the 3YOURMIND Admin Panel |
Setup a user
Login to the 3YOURMIND Platform as a user that has access to the admin panel.
Go to Administration > Users.
Click on Add User.
Enter username: machine_connectivity (or similar).
Enter a long random password. You won’t need it later.
Click on Save and continue editing.
Enter a valid Email Address.
Click on Save.
Provide access to the organization's fulfillment partners
Return to the homepage of the admin panel.
Go to User profiles.
Click on theuser you just created.
Make sure that the user is assigned to the correct site / domain.
Go back to the homepage of the admin panel.
Go to Fulfillment partner.
Open each service under the Fulfillment partner List.
Add the user you created to the list of users.
Click on Save.
Create API token
Go back to the homepage of the admin panel.
Go to Users under Authentication and Authorization.
Search for the user you created.
Click on Create Token.
Info |
---|
The token is only displayed once in the pop-up and not accessible later on. Make sure to copy the token right away. |
Note that this is sensitive information.
Service ID
Info |
---|
This step can be done by anyone with access to the Service Panel. |
Login to the 3YOURMIND Platform with a user that has access to the service panel.
Visit https://[your-domain]/api/v2.0/service-panel/services/.
Note the
id
of the service.
4. Aggregator Configuration
Download the binary release:We will provide you with a link to a ZIP archive that you can use to download the Aggregator.
Create a configuration
Together with the binary release you will find a sample configuration file called config.sample.json. Rename it to config.json and open it in a text editor:
Code Block |
---|
{ "machines": [...], // please visit child pages for configuration details of all supported machines "mes_services": [ { "id": 1, "url": "https://print.3yourmind.com/api/v2.0/machine/730/", "token": "28c1610a1240ecc5e9eae9b2e3a0554e64e8eeaf" } ], "aggregator_id": "my aggregator" } |
Info |
---|
Save your configuration under the name config.json |
Machines
In the machine section you will need to configure the URL(s) of the machine(s), give them a name of your choice, define their type and provide a list of mes_service
identifiers you want to send data to. Please refer to the tables below to see the configuration details of our supported machines/interfaces:
Carbon3D Machine Configuration
EOS Connect Machine Configuration
MTConnect Machine Configuration
Octoprint Machine Configuration
Ultimaker Machine Configuration
Formlabs Machine Configuration
MES services
Each mes_service
contains the Agile MES URL, a service ID and an API token. The following data must be set:
id
: This identifier is used to match Agile MES services and machines within the config.json. You can use any positive number, as long as it is unique.url
: This is the Agile MES URL in the formathttps://[your-domain]/api/v2.0/machine/[service ID]
token
: This is the API token of the user in the 3YOURMIND software created in step 3.
Example:
with 730
as serviceId
:
Code Block |
---|
{ "id": 1, "url": "https://print.3yourmind.com/api/v2.0/machine/730/", "token": "28c1610a1240ecc5e9eae9b2e3a0554e64e8eeaf" } |
5. Start the Aggregator
Make sure that the Aggregator is in the same network as each machine you want to connect to.
Make sure the Aggregator executable and the
config.json
you created are in the same directory.Run the executable.
Optionally install the Aggregator as a Windows service
Make sure the
install-as-service.bat
anduninstall-service.bat
are in the Aggregator's directory.Double-click on
install-as-service.bat
.
To remove the service and stop the Aggregator double-click on uninstall-service.bat
.
Optionally adjust the settings of the service:
Click on Windows Start, type Services and hit enter to open the service configuration panel.
Adjust the settings of the 3YOURMIND Aggregator service as desired. You can e.g. enable automatic restart of the service in case of an error.
6. Activate Machine Connectivity in the Agile MES
Login to the 3YOURMIND Platform with a user that has access to the Service Panel. If you do not have access to the service panel, please look at: Service Panel.
Open the Service Panel.
Go to Settings > Workstations.
Select the workstation that the machine should get connected to.
Select the machine in the Machine Connectivity section.
Click on Connect Machine.