Ametek Land SPOT+ User Manual
  1. Manuals
  2. Brands
  3. Ametek Land Manuals
  4. Measuring Instruments
  5. SPOT+
  6. User manual

Ametek Land SPOT+ User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
SPOT+ FAMILY
REST API USER GUIDE
LANGUAGE: ENGLISH
ISSUE: 1
DATE: 13 SEPTEMBER 2023
Advanced Digital Pyrometer Series
i
Q U A L I T Y C U S T O M E R S O L U T I O N S

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SPOT+ and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Ametek Land SPOT+

Summary of Contents for Ametek Land SPOT+

  • Page 1 SPOT+ FAMILY REST API USER GUIDE LANGUAGE: ENGLISH ISSUE: 1 DATE: 13 SEPTEMBER 2023 Advanced Digital Pyrometer Series Q U A L I T Y C U S T O M E R S O L U T I O N S...
  • Page 2 Observe precautions for handling electrostatic discharge sensitive devices. Equipment Operation Use of this instrument in a manner not specified by AMETEK Land may be hazardous. Read and understand the user documentation supplied before installing and operating the equipment. The safety of any system incorporating this equipment is the responsibility of the assembler.
  • Page 3 This manual is provided as an aid to owners of AMETEK Land’s products and contains information proprietary to AMETEK Land. This manual may not, in whole or part, be copied, or reproduced without the expressed written consent of AMETEK Land.

  • Page 4: Table Of Contents

    SPOT+ Contents Introduction Index of SPOT+ REST API Parameters SPOT+ Key Output Values 2.2 SPOT+ Fast Temperature Output Buffer SPOT+ Camera Images. SPOT+ Control Parameters SPOT+ Command Reference SPOT+ Key Output Values 3.1.1 Read Multiple: Mono Instruments 3.1.2 Read Multiple: Ratio Instruments 3.1.3 Read Multiple: Application Instruments 3.1.4 Temperature Measurements 3.1.5...

  • Page 5: Introduction

    This User Guide explains how to communicate with a SPOT+ pyrometer using the REST API. AMETEK Land’s SPOT+ range is a family of fully-featured smart pyrometers for non- contact temperature measurements. Available in a number of temperature ranges and models, SPOT+ pyrometers provide immediate local display and onboard analogue I/O together with multiple communication options over Ethernet: Embedded Webserver, Modbus TCP/IP, REST API (http) and EthernetIP.
  • Page 6 Before REST applications can change any parameters on the instrument during normal operation, the ethernet security level must be configured. Ethernet security settings for the SPOT+ are described in section 4. Example Javascript code is given in the final section of this document. A sample webpage using the REST API is available to download and copy from the AMETEK Land website, www.ametek-land.com/spot. 1 - 2 REST API User Guide...

  • Page 7: Index Of Spot+ Rest Api Parameters

    SPOT+ INDEX OF SPOT+ REST API PARAMETERS 2.1 SPOT+ Key Output Values The SPOT+ key output values can be read individually by a GET request to http://[ipaddress]/output?p=[parameter] or collectively as a GET request to http://[ipaddress]/output Parameter Read Write Definition and Range Target temperature output, after time functions and instrument mode calculations have been applied.

  • Page 8: Spot+ Fast Temperature Output Buffer

    SPOT+ Parameter Read Write Definition and Range Infrared signal strength as a percentage of that expected from a blackbody target of the same temperature as the target. Reduced signal strength can be due to target signalpc * emissivity less than 1 or obscuration of the sight path. Values integer % values from 0-100 %.

  • Page 9: Spot+ Control Parameters

    SPOT+ 2.4 SPOT+ Control Parameters The SPOT+ control parameters can be read and written individually as GET and PUT requests to http://[ipaddress]/control/p=[parameter]. Parameter Read Write Definition and Range User-entered emissivity value to correct measurements of a Mono pyrometer, or the Mono1 channel of a Ratio or emissivity1 Application Pyrometer.
  • Page 10 SPOT+ Parameter Read Write Definition and Range The index of the current App Mode. appnumber ** Integer values from 1 up to the number of Apps that are installed on the instrument. The calibration offset to the current App. appoffset ** Integer values from -2000 to 2000. Reference temperature used to adjust the emissivity of a Mono or Ratio pyrometer, or tune the current App of an Application pyrometer by setting a calibration offset...

  • Page 11: Spot+ Command Reference

    SPOT+ SPOT+ COMMAND REFERENCE 3.1 SPOT+ Key Output Values The principal measurement outputs from the SPOT+ thermometer can be read individually or altogether in a single ‘read multiple’ request. When a ‘read multiple’ request is used, the SPOT+ returns a formatted JSON file containing all parameters relevant to the particular instrument. Example communications are presented here for each type of instrument.

  • Page 12: Read Multiple: Application Instruments

    SPOT+ 3.1.3 Read Multiple: Application Instruments Application specific instruments additionally measure target emissivity at both measurement wavelengths. Request Example Reply GET http://[ipaddress]/output “temperature”:512.1, “itemperature”:41.2, “alarmstatus”:0, “d1temperature”:400.0, “d2temperature”:350.5, “signalpc”:10, “e1out”:0.101, “e2out”:0.975 3.1.4 Temperature Measurements Mode Request Example Reply Read single value GET http://[ipaddress]/output?p=temperature 512.1 3.1.5 Internal Temperature Mode Request Example Reply Read single value GET http://[ipaddress]/output?p=itemperature...

  • Page 13: Signal % (Ratio And Application Pyrometers Only)

    SPOT+ 3.1.8 Signal % (Ratio and Application Pyrometers only) Mode Request Example Reply Read single value GET http://[ipaddress]/output?p=signalpc 3.1.9 Emissivity Measurements (Application Pyrometers only) Mode Request Example Reply Read single value GET http://[ipaddress]/output?p=e1out 0.101 Mode Request Example Reply Read single value GET http://[ipaddress]/output?p=e2out 0.975 3.2 SPOT+ Fast Temperature Buffer...

  • Page 14: Spot+ Control Parameters

    SPOT+ 3.4 SPOT+ Fast Temperature Buffer SPOT+ control parameters can only be read and written individually. The ‘lock’ function on the SPOT+ webserver can be used to prevent unauthorized writing of SPOT+ control parameters. When the SPOT+ webserver is locked, it will be possible to read but not write to the control parameters.

  • Page 15: Command Input

    SPOT+ 3.4.5 Command Input Mode Request Example Reply Read single value GET http://[ipaddress]/control?p=cmdin PUT http://[ipaddress]/control?p=cmdin Write single value BODY=1 3.4.6 Error Code Mode Request Example Reply Read single value GET http://[ipaddress]/control?p=errorcode 0x0000 3.4.7 Information Mode Request Example Reply Read single value GET http://[ipaddress]/control?p=info SPOT+ R160 Ratio PP 3.4.8 App Number (Application Pyrometers Only)

  • Page 16: Error Responses

    SPOT+ 3.5 Error Responses If the SPOT+ cannot process the instruction, the appropriate http error code will be returned in response to the GET or PUT response. The response of the message will give additional information. http error code Message 400 Bad Request [parameter] not recognised 401 Unauthorized...

  • Page 17: Ethernet Security Settings

    SPOT+ ETHERNET SECURITY SETTINGS There are two security modes for SPOT+ Webserver and REST API communication: Secure or Open. ‘Secure’ is the recommended setting for SPOT+ control over ethernet in secure appli- cations. Several security features are enabled: • A handshake is required when a control application first tries to write a pa- rameter.

  • Page 18: Secure Communications

    SPOT+ 4.2 Secure Communications Unless the password is entered, the SPOT+ is effectively ‘Read Only’. All requested data will be sent but parameters cannot be changed over ethernet, even using the webserver. REST applications will respond to GET requests as expected, but PUT requests will return a ‘401 Unauthorized’ error. Before password entry, the yellow padlock symbol will be shown on each webserver page.

  • Page 19: Example Javascript Code

    SPOT+ EXAMPLE JAVASCRIPT CODE The code in this section is taken from the SPOT+ REST API Example Webpage, available to download from www.ametek-land.com/spot 5.1 Read All Outputs function readOutputs(){ //create a new XMLHttpRequest to read temperature measurements var outhttp = new XMLHttpRequest(); outhttp.open(“GET”, “http://10.1.10.50/output”, true);...

  • Page 20: Read The Image Stream

    SPOT+ //format temperature to 1 decimal place or ‘----.-’ for an over- or under-range value. let t = parseInt(this.responseText); //overrange values are transmitted as 65535 and under-range values as 65534 if (t>6553) t=”----.-”; //display the latest value in the webpage document.getElementById(“temperature”).innerHTML = t + “C”;...

  • Page 21: Read The Temperature Buffer

    SPOT+ 5.4 Read the Temperature Buffer function readBuffer(){ //create a new XMLHttpRequest to read the temperature buffer var bufferhttp = new XMLHttpRequest(); bufferhttp.open(“GET”, “http://10.1.10.50/buffer”, true); //configure the header to request JSON data bufferhttp.setRequestHeader(“Content-type”, “application/json;charset=utf-8”); //write a function to handle the reply bufferhttp.onreadystatechange = function() { if (this.readyState == 4 && this.status == 200) { //update the graph to display the latest buffer let reply = JSON.parse(this.responseText.replace(/(\r\n|\n|\r)/g,””)); let pointer = Number(reply.pointer); let points = “”; let min = Math.min(...reply.buffer); //scale the graph from min to max of the buffer let range = Math.max(...reply.buffer) - min;...

  • Page 22: Write To A Control Input

    SPOT+ 5.5 Write to a Control Input The protocol for writing parameters over http depends on the Security Mode of the SPOT+. The following code demonstrates how to switch the LED on and off in Open and in Secure mode. 5.5.1 Open Ethernet Communications function setLED(){ //this function writes a new value to the LED state //open a new XMLHttpRequest var ledhttpwrite = new XMLHttpRequest();...
  • Page 23 SPOT+ //configure the header to request JSON data ledhttpwrite.setRequestHeader(“Content-type”, “application/json;charset=utf-8”); //read the password let password = document.getElementById(“pass”).value; //create a JSON Web Token from the password, nonce and incremented nonce counter let jwt_bytes = createJWT(password, nonce, ++nonceCounter); let signedSecret = base64FromArrayBuffer(jwt_bytes); signedSecret = signedSecret.replaceAll(“=”, “”); let jwt = jwt_header + “.” + jwt_payload + “.” + signedSecret; //request headers are the full JSON web token, the nonce and nonce counter ledhttpwrite.setRequestHeader(“Authorization”, “Bearer “...
  • Page 24 AMETEK Land’s global service network provides unparalleled after-sales services to ensure you get the best performance and value from your AMETEK Land products. Our dedicated service centre teams and on-site engineers are trained to deliver the highest standard of commissioning, maintenance and after- sales support.

Table of Contents