harting euromap 15 gateway for mica user...

31
HARTING Euromap 15 Gateway for MICA User Manual

Upload: others

Post on 13-May-2020

17 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING Euromap 15 Gateway for MICA

User Manual

HARTING MICA Euromap 15 Gateway ndash User Manual

2 HARTING IT Software Development

3 Edition 2018

copy HARTING IT Software Development Espelkamp

All rights reserved including those of the translation

No part of this manual may be reproduced in any form (print photocopy microfilm or any

other process) processed duplicated or distributed by means of electronic systems without

the written permission of HARTING IT Software Development GmbH amp Co KG Espelkamp

Subject to alterations without notice

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 3

Contents

Contents 3

1 Installation 4

11 Installation of the Euromap15 Gateway 4

2 Euromap15 6

21 About Euromap15 6

22 The Communication Principle 6

3 The Euromap15 Gateway user interface 7

31 The section ldquoMachinerdquo 7

32 The section ldquoReportsrdquo 8

33 The section ldquoCommandsrdquo 11

4 The Euromap15 Gateway REST interface 16

41 DeviceSpec 17

42 Subscribers 17

43 CycleSpec 18

44 Variables 20

45 DataSets 21

46 JobDefinition 22

47 JobStatus 23

48 ProductionTarget 24

49 ProductionStatus 25

410 MachineIdentification 26

411 MachineStatus 27

412 OperatorIdentification 28

413 Alarms 29

414 Production Control Command 30

415 Time and Date 31

HARTING MICA Euromap 15 Gateway ndash User Manual

4 HARTING IT Software Development

1 Installation This installation guide refers to the MICA Base Version 170

You may skip this chapter if the ldquoEuromap15 Gatewayrdquo is already installed

11 Installation of the Euromap15 Gateway

Log in to the MICA with admin rights and click the ldquoInstallrdquo icon

On the next view select the installation archive of the ldquoEUROMAP 63 Gatewayrdquo Next click the ldquoExecuterdquo button

In the following dialog enter a unique name for the container

As soon as the icon is visible you can configure the container (see chapter 1111) After that the device is ready to be connected with the injection molding machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 5

111 Basic Container functionality

Right clicking the ldquoEUROMAP 15 Gatewayrdquo Container tile opens the containerrsquos context menu Press ldquoOptionsrdquo to expand the following functions

1 StartStop App

2 Settings provides the container information and lets you configure the IPv4 IPv6 settings an Additional Network Interface and the Single Sign On Mode

3 Duplicate lets you duplicate the container on your MICA

4 Export lets you export the container to your PC All configurations you set will be kept

5 Merge overwrites the reset point of the Container with its current configuration

6 Update lets you update the ldquoEuromap 15 Gatewayrdquo container

7 Reset resets the configuration of the ldquoEuromap 15 Gatewayrdquo Container to factory default

8 Delete lets you delete the container

1111 Network Settings

In the containerrsquos context menu click ldquoSETTINGSrdquo to configure the containerrsquos IPv4 setting and confirm by clicking the ldquoActivate Settingsrdquo buttons An IPv4 configuration (Static or DHCP) is mandatory for the container to be able to establish a connection to a machine When done go back to ldquoHomerdquo and click ldquoStart Apprdquo in the containers context menu to start the container

The ldquoEUROMAP 15 Gatewayrdquo is now ready to be connected to a machine

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 2: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

2 HARTING IT Software Development

3 Edition 2018

copy HARTING IT Software Development Espelkamp

All rights reserved including those of the translation

No part of this manual may be reproduced in any form (print photocopy microfilm or any

other process) processed duplicated or distributed by means of electronic systems without

the written permission of HARTING IT Software Development GmbH amp Co KG Espelkamp

Subject to alterations without notice

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 3

Contents

Contents 3

1 Installation 4

11 Installation of the Euromap15 Gateway 4

2 Euromap15 6

21 About Euromap15 6

22 The Communication Principle 6

3 The Euromap15 Gateway user interface 7

31 The section ldquoMachinerdquo 7

32 The section ldquoReportsrdquo 8

33 The section ldquoCommandsrdquo 11

4 The Euromap15 Gateway REST interface 16

41 DeviceSpec 17

42 Subscribers 17

43 CycleSpec 18

44 Variables 20

45 DataSets 21

46 JobDefinition 22

47 JobStatus 23

48 ProductionTarget 24

49 ProductionStatus 25

410 MachineIdentification 26

411 MachineStatus 27

412 OperatorIdentification 28

413 Alarms 29

414 Production Control Command 30

415 Time and Date 31

HARTING MICA Euromap 15 Gateway ndash User Manual

4 HARTING IT Software Development

1 Installation This installation guide refers to the MICA Base Version 170

You may skip this chapter if the ldquoEuromap15 Gatewayrdquo is already installed

11 Installation of the Euromap15 Gateway

Log in to the MICA with admin rights and click the ldquoInstallrdquo icon

On the next view select the installation archive of the ldquoEUROMAP 63 Gatewayrdquo Next click the ldquoExecuterdquo button

In the following dialog enter a unique name for the container

As soon as the icon is visible you can configure the container (see chapter 1111) After that the device is ready to be connected with the injection molding machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 5

111 Basic Container functionality

Right clicking the ldquoEUROMAP 15 Gatewayrdquo Container tile opens the containerrsquos context menu Press ldquoOptionsrdquo to expand the following functions

1 StartStop App

2 Settings provides the container information and lets you configure the IPv4 IPv6 settings an Additional Network Interface and the Single Sign On Mode

3 Duplicate lets you duplicate the container on your MICA

4 Export lets you export the container to your PC All configurations you set will be kept

5 Merge overwrites the reset point of the Container with its current configuration

6 Update lets you update the ldquoEuromap 15 Gatewayrdquo container

7 Reset resets the configuration of the ldquoEuromap 15 Gatewayrdquo Container to factory default

8 Delete lets you delete the container

1111 Network Settings

In the containerrsquos context menu click ldquoSETTINGSrdquo to configure the containerrsquos IPv4 setting and confirm by clicking the ldquoActivate Settingsrdquo buttons An IPv4 configuration (Static or DHCP) is mandatory for the container to be able to establish a connection to a machine When done go back to ldquoHomerdquo and click ldquoStart Apprdquo in the containers context menu to start the container

The ldquoEUROMAP 15 Gatewayrdquo is now ready to be connected to a machine

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 3: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 3

Contents

Contents 3

1 Installation 4

11 Installation of the Euromap15 Gateway 4

2 Euromap15 6

21 About Euromap15 6

22 The Communication Principle 6

3 The Euromap15 Gateway user interface 7

31 The section ldquoMachinerdquo 7

32 The section ldquoReportsrdquo 8

33 The section ldquoCommandsrdquo 11

4 The Euromap15 Gateway REST interface 16

41 DeviceSpec 17

42 Subscribers 17

43 CycleSpec 18

44 Variables 20

45 DataSets 21

46 JobDefinition 22

47 JobStatus 23

48 ProductionTarget 24

49 ProductionStatus 25

410 MachineIdentification 26

411 MachineStatus 27

412 OperatorIdentification 28

413 Alarms 29

414 Production Control Command 30

415 Time and Date 31

HARTING MICA Euromap 15 Gateway ndash User Manual

4 HARTING IT Software Development

1 Installation This installation guide refers to the MICA Base Version 170

You may skip this chapter if the ldquoEuromap15 Gatewayrdquo is already installed

11 Installation of the Euromap15 Gateway

Log in to the MICA with admin rights and click the ldquoInstallrdquo icon

On the next view select the installation archive of the ldquoEUROMAP 63 Gatewayrdquo Next click the ldquoExecuterdquo button

In the following dialog enter a unique name for the container

As soon as the icon is visible you can configure the container (see chapter 1111) After that the device is ready to be connected with the injection molding machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 5

111 Basic Container functionality

Right clicking the ldquoEUROMAP 15 Gatewayrdquo Container tile opens the containerrsquos context menu Press ldquoOptionsrdquo to expand the following functions

1 StartStop App

2 Settings provides the container information and lets you configure the IPv4 IPv6 settings an Additional Network Interface and the Single Sign On Mode

3 Duplicate lets you duplicate the container on your MICA

4 Export lets you export the container to your PC All configurations you set will be kept

5 Merge overwrites the reset point of the Container with its current configuration

6 Update lets you update the ldquoEuromap 15 Gatewayrdquo container

7 Reset resets the configuration of the ldquoEuromap 15 Gatewayrdquo Container to factory default

8 Delete lets you delete the container

1111 Network Settings

In the containerrsquos context menu click ldquoSETTINGSrdquo to configure the containerrsquos IPv4 setting and confirm by clicking the ldquoActivate Settingsrdquo buttons An IPv4 configuration (Static or DHCP) is mandatory for the container to be able to establish a connection to a machine When done go back to ldquoHomerdquo and click ldquoStart Apprdquo in the containers context menu to start the container

The ldquoEUROMAP 15 Gatewayrdquo is now ready to be connected to a machine

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 4: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

4 HARTING IT Software Development

1 Installation This installation guide refers to the MICA Base Version 170

You may skip this chapter if the ldquoEuromap15 Gatewayrdquo is already installed

11 Installation of the Euromap15 Gateway

Log in to the MICA with admin rights and click the ldquoInstallrdquo icon

On the next view select the installation archive of the ldquoEUROMAP 63 Gatewayrdquo Next click the ldquoExecuterdquo button

In the following dialog enter a unique name for the container

As soon as the icon is visible you can configure the container (see chapter 1111) After that the device is ready to be connected with the injection molding machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 5

111 Basic Container functionality

Right clicking the ldquoEUROMAP 15 Gatewayrdquo Container tile opens the containerrsquos context menu Press ldquoOptionsrdquo to expand the following functions

1 StartStop App

2 Settings provides the container information and lets you configure the IPv4 IPv6 settings an Additional Network Interface and the Single Sign On Mode

3 Duplicate lets you duplicate the container on your MICA

4 Export lets you export the container to your PC All configurations you set will be kept

5 Merge overwrites the reset point of the Container with its current configuration

6 Update lets you update the ldquoEuromap 15 Gatewayrdquo container

7 Reset resets the configuration of the ldquoEuromap 15 Gatewayrdquo Container to factory default

8 Delete lets you delete the container

1111 Network Settings

In the containerrsquos context menu click ldquoSETTINGSrdquo to configure the containerrsquos IPv4 setting and confirm by clicking the ldquoActivate Settingsrdquo buttons An IPv4 configuration (Static or DHCP) is mandatory for the container to be able to establish a connection to a machine When done go back to ldquoHomerdquo and click ldquoStart Apprdquo in the containers context menu to start the container

The ldquoEUROMAP 15 Gatewayrdquo is now ready to be connected to a machine

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 5: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 5

111 Basic Container functionality

Right clicking the ldquoEUROMAP 15 Gatewayrdquo Container tile opens the containerrsquos context menu Press ldquoOptionsrdquo to expand the following functions

1 StartStop App

2 Settings provides the container information and lets you configure the IPv4 IPv6 settings an Additional Network Interface and the Single Sign On Mode

3 Duplicate lets you duplicate the container on your MICA

4 Export lets you export the container to your PC All configurations you set will be kept

5 Merge overwrites the reset point of the Container with its current configuration

6 Update lets you update the ldquoEuromap 15 Gatewayrdquo container

7 Reset resets the configuration of the ldquoEuromap 15 Gatewayrdquo Container to factory default

8 Delete lets you delete the container

1111 Network Settings

In the containerrsquos context menu click ldquoSETTINGSrdquo to configure the containerrsquos IPv4 setting and confirm by clicking the ldquoActivate Settingsrdquo buttons An IPv4 configuration (Static or DHCP) is mandatory for the container to be able to establish a connection to a machine When done go back to ldquoHomerdquo and click ldquoStart Apprdquo in the containers context menu to start the container

The ldquoEUROMAP 15 Gatewayrdquo is now ready to be connected to a machine

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 6: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

6 HARTING IT Software Development

2 Euromap15

21 About Euromap15

Euromap 15 is a basic communication protocol which is necessary to establish a

communication between a central computer and an injection molding machine by a

masterslave principle Here we use a MICA Base as the central computer to communicate

with the machine

22 The Communication Principle

The communication between the central computer and the machine controller occur in

regular intervals It starts every time with a standard question from the central computer

(Telegram ldquo000rdquo) A machine may not send any telegram to the central computer unless it

is asked to do so The machine answer to the standard question with a standard answer

(Telegram ldquo100rdquo) and a note of a service request ie ldquo000rdquo (no service requested)

The machine can also be asked any other command without a preceding request The

machine has to answer the command by sending a corresponding response or by sending a

negative acknowledgement

A telegram from the central computer to the machine is called command

Central computer Machine = Command

A telegram from the machine to the central computer is called response

Machine Central computer = Response

An example for a communication

Telegram Description

ldquo000rdquo

ldquo100rdquo+rdquo001rdquo

ldquo001rdquo

ldquo101rdquo+rdquo007rdquo

Command form the central computer standard question

Response from the machine + service request for the machine

identification

Command from the central computer Request for the machine

identification

Response from the machine machine identification + manufacture

code ie ldquoKrauss Maffeirdquo

For further information refer to

httpwwweuromaporg

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 7: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 7

3 The Euromap 15 Gateway user interface With a click on the ldquoEUROMAP 15 Gatewayrdquo icon the user interface of the gateway

appears

The exclamation mark below the HARTING logo indicates that the ldquoEUROMAP 15 Gatewayrdquo

Container is not yet licensed Therefore it will run for a test period of 6h only but can be

restarted manually

To obtain a license key click on ldquoActivaterdquo and follow the steps in the popup box

31 The section ldquoMachinesrdquo

The section ldquoMachinesrdquo is for connecting the machine to your MICA Click on the applied

machine A window will appear were you can enter the needed data for connecting the

machine to the MICA

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 8: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

8 HARTING IT Software Development

By clicking on the machine you are able to enter the URL of the machine host and port in

the corresponding field and set the ldquoObservation Intervalrdquo you want to request the machine

by the MICA

32 The section ldquoReportsrdquo

In this section ldquoReportsrdquo you choose the information you want to get from the machine and

publish on the ldquoSubscriberrdquo endpoint by activating corresponding buttons

You can also observe a set of variables You can add new variables with a click on

or delete existing ones by clicking on

To get a list of all available variables for a machine you can use the ldquoVariablerdquo command

(see section 3313)

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 9: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 9

Unique Name of the report

Duration of the report

Repeat Period of the report

List of Variables

Outputs that should be

reported

If more than one machine is available a list machine list will be shown below ldquoRepeat

Periodrdquo You can select the machine which should be used for the report If there are less

than 2 machines available this list will not be visible

For adding a new ldquoSubscriberrdquo endpoint you have to click on the small icon on the left

side of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 10: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

10 HARTING IT Software Development

A menu will appear where you can add a new ldquoSubscriberrdquo endpoint to publish the gathered

information from the machine The supported types of endpoints are HTTP HTTPS MQTT

MQTTS TCP and UDP Important note Make sure to use unique client ids for every

MQTTMQTTS Subscriber

You can activate the endpoints with a click on or delete an endpoint with the delete

button

321 Example for a ldquoReportrdquo

If you have configured your ldquoMachinerdquo and ldquoReportsrdquo you will get a report after the

ldquoDurationrdquo which was specified by you

A ldquoReportrdquo is a JSON structure containing the following fields

Report

applicationId String

reportName String

date String

totalMilliseconds Integer

devices Devices[]

The fields of the ldquoReportsrdquo are specified in the following table

Field Type Description

applicationId String The ID of the application In this case it is

always ldquoEuromap15Gatewayrdquo

reportName String The name of the report which is set in the

section ldquoReportsrdquo

date String The time stamp of the report

totalMilliseconds Integer The duration of the report

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 11: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 11

devices Device[] All monitored machines containing all captured

fields

You find an example of a report in the field below

applicationId Euromap15Gateway

reportName test

date 2018-03-15T141414006

totalMilliseconds 999

initiation REPEAT_PERIOD

initiator null

termination DURATION

terminator null

devices [

name machine

fields [

name Job Status

value

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 4257

noOfRejectedPartsSinceStartOfJob 30

averageCycleTime 1646

actualNoOfCavitiesInProduction 1

33 The section ldquoCommandsrdquo

In the section ldquoCommandsrdquo you can issue most Euromap15 commands

331 General

The button is for requesting information from the machine

The button is for transfer information or data to the machine

If you want to request or transfer information fromto the machine you have to click on the

corresponding button A loading icon will appear

If the process was successful the loading icon disappear

If the process was not successful the loading icon disappear and an error message appears

at the bottom of your window By clicking in your window the error message disappear

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 12: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

12 HARTING IT Software Development

332 ldquoJob Definitionrdquo

In the sub-section ldquoJob Definitionrdquo you can get information about the ldquoJobrdquo the machine is

working on It include the ldquojob coderdquo ldquopart coderdquo and the ldquodataset idrdquo which are needed to

get the ldquoJobrdquo done

You have to send the information to the machine every time you start a new ldquoJobrdquo Enter the

codes in the corresponding area and click on the ldquoTransferrdquo button

333 ldquoProduction Targetrdquo

In the sub-section ldquoProduction Targetrdquo you can set the ldquono of lotsrdquo and the ldquono of parts per

lotrdquo or you can get this information from the machine

334 ldquoJob Statusrdquo

In the sub-section ldquoJob Statusrdquo you can request the current status of the job If you have to

interrupt the current job and want to start at a later date it is possible to request the status

and transfer the status later back to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 13: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 13

335 ldquoProduction Control Commandrdquo

In the sub-section ldquoProduction Control Commandrdquo you can transfer a remote command to

the machine ie REMOTE_STOP_OF_MACHINE_AT_END_OF_CYCLE

REMOTE_START_OF_MACHINE_CYCLE REMOTE_START_UP and REMOTE_SHUT_DOWN

336 ldquoProduction Statusrdquo

In the sub-section ldquoProduction Statusrdquo you can request in which status of production the

machine is ie production preparation for production production

target reached and so on If any error exist you also see the reason for the error

337 ldquoMachine Statusrdquo

In the sub-section ldquoMachine Statusrdquo you can request the current status of the machine ie

fully_automatic semi_automatic idle and so on

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 14: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

14 HARTING IT Software Development

338 ldquoAlarmsrdquo

In the sub-section ldquoalarmsrdquo you can see the reason for an alarm which can appear The

alarm reasons are specified by the machine manufacturer

339 ldquoOperator IDrdquo

In the sub-section ldquoOperator IDrdquo you can see the current operator which operates the

machine

3310 ldquoTime and Daterdquo

In the sub-section ldquoTime and Daterdquo you can set the current time and date and transfer it to the machine

3311 ldquoMachine IDrdquo

In the sub-section ldquoMachine IDrdquo you can request the machine identification which is set by

the machine manufacturer during the construction

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 15: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 15

3312 ldquoData Setrdquo

In the sub-section ldquoData Setrdquo you can transfer or request data sets according to the

ldquoDataSet IDrdquo you set in the section ldquoJob Definitionrdquo

3313 ldquoVariablerdquo

In this sub-section ldquoVariablesrdquo you can request and transfer variables These variables are

irrespective of the variables in the section ldquoObservationrdquo So it is possible to monitor

variables independent of the variables you transfer to the machine

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 16: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

16 HARTING IT Software Development

4 The Euromap15 Gateway REST interface The ldquoEuromap15 Gatewayrdquo provides a REST interface which provides the same

functionality as the user interface The REST based http interface will look like shown in the

following table while each resource begins with

http[Container-Host]resteuromap15

ltInterfacegt

Euromap15 Gateway

Method Resource Parameter (JSON)

------- --------- ----------------

GET devices MapltString DeviceSpecgt

GETPUT devicesid DeviceSpec

GETPUT devicesidjobdefinition JobDefinition

GETPUT devicesidjobstatus JobStatus

GETPUT devicesidproductiontarget ProductionTarget

GETPUT devicesidvariables Variable[]

GETPUT devicesiddatasetdata_id Stream

GET devicesidmachineid MachineIdentification

GET devicesidoperatorid OperatorIdentification

GET devicesidproductionstatus ProductionStatus

GET devicesidmachinestatus MachineStatus

GET devicesidalarms Alarms

PUT devicesiddatetime TimeAndDate

PUT devicesidproductioncontrolcommand ProductionControlCommand

GET cycles MapltString CycleSpecgt

POST cycles CycleSpec

GETPUT cyclesid CycleSpec

DELETE cyclesid

GET cyclesidsubscribers MapltString Subscribergt

POST cyclesidsubscribers Subscriber

PUT cyclesidsubscriberssub_id Subscriber

DELETE cyclesidsubscriberssub_id

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 17: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 17

41 DeviceSpec

Url Parameter Description

GET

devices

MapltString

DeviceSpecgt

With this resource you can get

information about the machine

GETPUT

devicesid

DeviceSpec With this resource you can set the

configuration of the machine the MICA

should communicate with

DeviceSpec is a JSON structure containing the following fields

DeviceSpec

specId String

name String

properties MapltString Stringgt

fields MapltString Fieldgt

The fields of a DeviceSpec are specified in the following table

Field Type Description

specId String The ID of the specification

Name String The name of the specification

Properties MapltString Stringgt The device properties

Fields integer The device fields

Example

id 3

name machine

label machine

properties

pollInterval 1000

haviscaptureperiod 1000

address 1

sendReceiveTimeout 30000

port 10000

dataSetTransferTimeout 60000

host 1012921316

openCloseTimeout 120000

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 18: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

18 HARTING IT Software Development

42 CycleSpec

Url Parameter Description

GET

cycles

MapltString

CycleSpecgt

With this resource you can get

information about the CycleSpec

POST

cycles

CycleSpec With this resource you can add new

CycleSpecs

GETPUT

cyclesid

CycleSpec With this resource you can

configure the CycleSpecs

DELETE

cycleid

With this resource you can delete a

report

CycleSpec is a JSON structure containing the following fields

CycleSpec

id String

applicationId String

enabled Boolean

duration Long

repeatPeriod Long

fieldSubscriptions MapltString SetltStringgtgt

The fields of a CycleSpec are specified in the following table

Field Type Description

id String The ID of the report

applicationId String The ID of the application

enable Boolean The status of the report

duration Long The duration of the report

repeatPeriod Long The repeat period of the report

fieldSubscription MapltString

SetltStringgtgt

The observed parameter

Example

id c2687f0f-2141-45c5-8bef-6ac831a9644e

applicationId Euromap15Gateway

name Report1

enabled false

duration 1000

repeatPeriod 0

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 19: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 19

fieldSubscriptions

77b9d64f-e7db-4125-803f-bff4fa10b241 [ VariablesP126 ProductionStatus

JobDefinition ]

43 Subscriber

Url Parameter Description

GET

cycleidsubscribers

MapltString

Subscribergt

With this resource you get a list

of all subscribers

POST

cycleidsubscribers

Subscriber With this resource you add a

new subscriber to the list

GETPUT

cycleidsubscriber

sub_id

Subscriber With this resource you can

active or deactivate the single

subscriber

DELETE

cycleidsubscriber

sub_id

With this resource you can

delete a single subscriber

Subscribers is a JSON structure containing the following fields

Subscriber

ID String read only

uri String

enable Boolean

properties Property[]

The fields of a Subscriber are specified in the following table

Field Type Description

ID String The ID of the subscriber

uri String The address of the subscriber

enable Boolean The status of the subscriber

properties Property[] A list of properties which are needed for

some ldquosubscriberrdquo endpoints

Example

id 27c77d93-758b-47f7-93b5-3eec831ad83c

enable false

uri tcp1270015555

properties

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 20: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

20 HARTING IT Software Development

44 Variables

Url Parameter Description

GETPUTdevices

idvariables

Variable[] With this resource you can put and get

the specified variables

Variables is a JSON structure containing the following fields

Variables

name String

value String

The fields of the Variables are specified in the following table

Field Type Description

name String The name of the variable

value String The value of the variable

Example

[

name L1001

value 0815

name L1102

value 4711

]

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 21: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 21

45 DataSets

Url Parameter Description

GETPUT

devicesiddatasetsdid

did id of

dataset

Request Body

OctetStream

With this resource you can

upload and download the

production data set

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 22: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

22 HARTING IT Software Development

46 JobDefinition

Url Parameter Description

GETPUT

devicesjobdefinition

JobDefinition With this resource you can get or

put the definition of the job

JobDefinition is a JSON structure containing the following fields

JobDefinition

jobCode String

partCode String

dataSetId String

The fields of a JobDefinition are specified in the following table

Field Type Description

jobCode String The code of the job

partCode String The part code of the parts you want to

produce

dataSetId String The ID of the data set which is to be used

Example

jobCode

partCode

dataSetId 906_294B

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 23: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 23

47 JobStatus

Url Parameter Description

GETPUT

devicesidjobstatus

JobStatus With this resource you can get or

put information about the current

job status

JobStatus is a JSON structure containing the following fields

JobStatus

noOfLotsCompleted Integer

actualNoOfPartsWithinLastLot Integer

noOfRejectedPartsSinceStartOfJob Integer

avaregeCycleTime Integer

actualNoOfCavitiesInProduction Integer

The fields of a JobStatus are specified in the following table

Field Type Description

noOfLotsCompleted Integer The no of lots which are

completed

actualNoOfPartsWithinLastLot Integer The actual no of parts

within the las lot

noOfRejectedPartsSinceStartOfJob Integer The no of rejected parts

since the start of the job

averageCycleTime Integer The average cycle time

actualNoOfCavitiesInProduction Integer The actual no of cavities

in the production

Example

noOfLotsCompleted 0

actualNoOfPartsWithinLastLot 20260

noOfRejectedPartsSinceStartOfJob 4

averageCycleTime 2428

actualNoOfCavitiesInProduction 4

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 24: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

24 HARTING IT Software Development

48 ProductionTarget

Url Parameter Description

GETPUT

devicesidproductiontarget

ProductionTarget With this resource

you can get and put

the target of the

production

ProductionTarget is a JSON structure containing the following fields

ProductionTarget

noOfLots Integer

noOfpartsPerLot Integer

The fields of a ProductionTarget are specified in the following table

Field Type Description

noOfLots Integer The no of lots of the production

noOfpartsPerLot Integer The no of parts per lot of the production

Example

noOfLots 1

noOfPartsPerLot 21000

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 25: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 25

49 ProductionStatus

Url Parameter Description

GET

devicesid

productionstatus

ProductionStatus With this resource you can

get information about the

current production status

ProductionStatus is a JSON structure containing the following fields

ProductionStatus

status String

reason Byte

The fields of a ProductionStatus are specified in the following table

Field Type Description

status String The status of the production

reason Byte The reason for the status of the production

Example

status PRODUCTION

reason 0

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 26: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

26 HARTING IT Software Development

410 MachineIdentification

Url Parameter Description

GET

devicesid

machineid

MachineIdentification With this resource you can

identify the connected machine

MachineIdentification is a JSON structure containing the following fields

MachineIdentification

communicationProtocolVersion String

manufactureCode String

machineCode String

The fields of a MachineIdentification are specified in the following table

Field Type Description

communicationProtocolVersion String The version of the used

communication protocol

manufactureCode String The manufacture code which

is specified by the

manufacturer

machineCode String The machine code which is

specified by the manufacturer

Example

communicationProtocolVersion V1_3

manufacturerCode NETSTAL

machineCode 2014031801 ELION-800-270

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 27: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 27

411 MachineStatus

Url Parameter Description

GET

devicesid

machinestatus

MachineStatus With this resource you can get

the status of the connected

machine

MachineStatus is a JSON structure containing the following fields

MachineStatus

status String

The fields of a MachineStatus are specified in the following table

Field Type Description

status String The status of the machine

Example

status FULLY_AUTOMATIC

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 28: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

28 HARTING IT Software Development

412 OperatorIdentification

Url Parameter Description

GET

devicesid

operatorid

OperatorIdentification With this resource you can

get information about the

operator

OperatorIdentification is a JSON structure containing the following fields

OperatorIdentification

operatorId String

The fields of an OperatorIdentification are specified in the following table

Field Type Description

operatorId String The ID of the operator

Example

operatorId 1

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 29: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 29

413 Alarms

Url Parameter Description

GET

devicesidalarms

Alarms With this resource you can get

information about the alarms

Alarms is a JSON structure containing the following fields

Alarms

alarmReason String

The fields of the Alarms are specified in the following table

Field Type Description

alarmReason String The reason for the alarm

Example

alarmReasons []

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 30: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

30 HARTING IT Software Development

414 Production Control Command

Url Parameter Description

PUT

devicesid

productioncon

trolcommand

ProductionControlCommand With this resource you can sent

a remote command to the

machine

ProductionControlComand is a JSON structure containing the following fields

ProductionControlCommand

productionControlCommand String

The fields of the ProductionControlComand are specified in the following table

Field Type Description

ProductionControllCommand String The remote command for the

machine

Example

productioncontrolcommand ldquoREMOTE_START_UPrdquo

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo

Page 31: HARTING Euromap 15 Gateway for MICA User Manualmica-container.com/container/Euromap15_Gateway/Euromap... · 2019-02-20 · HARTING MICA Euromap 15 Gateway – User Manual HARTING

HARTING MICA Euromap 15 Gateway ndash User Manual

HARTING MICA Euromap15 Gateway 31

415 Time and Date

Url Parameter Description

PUT

devicesid

datetime

TimeAndDate With this resource you can set the time

and date

TimeAndDate is a JSON structure containing the following fields

TimeAndDate

datetime String

The fields of the TimeAndDate are specified in the following table

Field Type Description

seconds Integer The seconds of the time

minutes Integer The minutes of the time

hours Integer The hour of the time

day Integer The current day

dayOfWeek Integer The day of the week

month Integer The current month

year Integer The current year

Example

date 2018-03-15T141413012rdquo