1. Manuals
  2. Brands
  3. Spectris Manuals
  4. Laboratory Equipment
  5. Malvern Panalytical AERIS
  6. Automation manual

Spectris Malvern Panalytical AERIS Automation Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

AERIS
AUTOMATION MANUAL
AUTOMATION MANUAL

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Malvern Panalytical AERIS and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Spectris Malvern Panalytical AERIS

Summary of Contents for Spectris Malvern Panalytical AERIS

  • Page 1 AERIS AUTOMATION MANUAL AUTOMATION MANUAL...
  • Page 2 AERIS AUTOMATION MANUAL EDITION NOTICE: 4023 002 89451, July 2019 This is the original publication of Edition 1 of this document, to be used with the Aeris instrument.
  • Page 3 DISCLAIMER Although diligent care has been used to ensure that the information in this material is accurate, nothing herein can be construed to imply any representation or warranty as to the accuracy, correctness or completeness of this information and we shall not be liable for errors contained herein or for damages in connection with the use of this material.

  • Page 4: Table Of Contents

    TABLE OF CONTENTS Chapter 1. Introduction......... 5 Chapter 2.
  • Page 5 TABLE OF CONTENTS 3.6 Message contents ”EVENTS)........30 3.6.1 Sample measured.

  • Page 6: Chapter 1 Introduction

    CHAPTER 1 INTRODUCTION This Automation Manual gives a description of the hardware and software that is necessary to use the Aeris in an automation environment. The initial installation of the Aeris must always be done by a Malvern Panalytical service engineer. Before you install the Aeris in automation, make sure that the installation site agrees with the speciications.

  • Page 7: Chapter 2 Hardware And Signals

    CHAPTER 2 HARDWARE AND SIGNALS 2.1 Specifications for Aeris in automation In a standard automation environment, the conveyor belt is installed on the left side of the Aeris sample changer where it replaces sample position 1. If you want the conveyor belt installed on the right side or on both sides of the Aeris sample changer, contact your local Malvern Panalytical sales organization.

  • Page 8: Activate The Licenses

    CHAPTER 2 HARDWARE AND SIGNALS Figure 2.2 Wires connected to the connection block 5. Examine the calibration of the Aeris sample changer. Calibration of the sample changer must be done by a Malvern Panalytical service engineer. NOTE: This visit can be invoiced. 2.3 Activate the licenses Before you can use the Aeris in automation, you must activate the Aeris instrument suite license and the automation license.

  • Page 9: Go To Advanced Mode

    CHAPTER 2 HARDWARE AND SIGNALS 8. Select IP coniguration. 9. Press Open. 10. Go to Conigure IP settings. 11. Tap in the IP address ield. 12. Change the IP address. NOTE: UAI uses TCP/IP port 702. 13. Press Set static IP address. 2.6 Go to Advanced mode 1.

  • Page 10: Chapter 3 Universal Automation Interface

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.1 Messages In this section, the messages are given that can be sent by the external control system to the UAI. The system works as a client/server system. Aeris is the server and the host is the client. The host sends the commands and Aeris reacts.

  • Page 11: Time_Stamp Format

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE • The application used to measure the sample. • The unload position where the sample is placed when the measurement is done. • The <sample_state> of the sample. • The last measurement result of the sample ”only if <sample_state> is measok). The sample administration in the UAI server and user interface is synchronized in both directions.

  • Page 12: Message Contents "Commands)

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5 Message contents (COMMANDS) 3.5.1 Request system status Description Requests the actual status of the total system Syntax Message @STATUS_REQUEST @SYSTEM @END Response @STATUS [@TIME_STAMP=<date_time>] @SYSTEM=<system_state> @END Details • The response can also be sent as an event when the instrument status changes. Example =>...

  • Page 13: Request Spectrometer/Sample Changer/Takeover Status

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.2 Request spectrometer/sample changer/takeover status Description Requests the actual status of a speciied unit or all units Syntax Message @STATUS_REQUEST [@UNIT =<unit_id>] @END Response @STATUS [@TIME_STAMP=<date_time>] @UNIT=xrd @READY=bool @MODE=<unit_mode> @END Details • Permitted in local mode. •...

  • Page 14: Request List Status

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.3 Request list status Description Requests the actual status of the list Syntax Message @STATUS_REQUEST @LIST @END Response 1 @STATUS [@TIME_STAMP=<date_time>] @LIST @STATE=nolist @END Response 2 @STATUS [@TIME_STAMP=<date_time>] @LIST=<list_name> @STATE=running @END Details • Permitted in local mode. •...

  • Page 15: Request Sample Status

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.4 Request sample status Description Requests the actual status of 1 or all samples. This command can also be used to see which sample is on a speciied location or unit. Syntax Message @STATUS_REQUEST @SAMPLE_ID[=<sample_id>] [@AT=<sample_position>] @END Response 1...

  • Page 16: Request Parameter Status

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.5 Request parameter status Description Requests the actual value of a parameter”s) ”system and unit”s)) Syntax Message @STATUS_REQUEST @PARAMETER[=<parameter_id>] @END Response @STATUS [@TIME_STAMP=<date_time>] @UNIT=xrd {@LOAD_POS=”empty|solid|unknown)} {@ACCESS=”true|false)} @END Details • Permitted in local mode. • The response can also be sent as an event when the instrument status changes. •...

  • Page 17: Request Location State

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.6 Request location state Description Requests the actual value of a location state ”detected by hardware) Syntax Message @STATUS_REQUEST @LOCATION=<sample_position> [@UNIT=<unit_id>] @END Response @STATUS [@TIME_STAMP=<date_time>] @LOCATION=<sample_position> @UNIT=xrd @STATE=<location_state> @END Details • Permitted in local mode. •...

  • Page 18: Request Connection Status

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.7 Request connection status Description Ability for the host to check the connection with the UAI Syntax Message @STATUS_REQUEST @SQ_ALIVE @END Response @STATUS @SQ_ALIVE @END Details • Permitted in local mode. • This command is only implemented for backwards compatibility. Example =>...

  • Page 19: System Restart

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.8 System restart Description Starts the system again Syntax Message @SYSTEM @RESTART @END Response @SYSTEM @RESTART @STATUS=normal @END Details • Not permitted in local mode. • This command is only implemented for backwards compatibility. • The system will not be started again, only a response with STATUS=normal will be returned. Example A system restart is requested.

  • Page 20: System Lush

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.9 System flush Description Flushes the incoming and outgoing messages Syntax Message @SYSTEM @FLUSH_SQ_MESSAGES @END Response @SYSTEM @FLUSH_SQ_MESSAGES @STATUS=normal @END Details • Permitted in local mode. • This command is only implemented for backwards compatibility. •...

  • Page 21: System Set

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.10 System set Description Sets the communication parameters of the UAI at run time Syntax Message @SYSTEM @SET [@STATUS_SYSTEM=bool] [@STATUS_UNIT=bool] [@STATUS_PARAMETER=bool] [@MEASURED=bool] [@REMOVED=bool] [@MOVED=bool] [@MESSAGE=bool] [@MESSAGE_MASK=0|1|2|3] [@TIME_STAMP=bool] @END Response @SYSTEM @SET @STATUS=normal|fatal @END Details Table 3.2 @SYSTEM@SET parameters Parameter Related event...
  • Page 22 CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE Example => @SYSTEM@SET@STATUS_SYSTEM=yes@STATUS_UNIT=yes@STATUS_PARAMETER=yes @MEASURED=yes@REMOVED=yes@MOVED=yes@MESSAGE=yes@MESSAGE_MASK=7 @TIME_STAMP=yes@END <= @SYSTEM@SET@STATUS=normal@END...

  • Page 23: List

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.11 List Description Updates the list administration Syntax Message @LIST [@OPEN@NAME=<list_name>] [@CLOSE] [@START] [@STOP] [@RESUME] @END Response @LIST @STATUS=normal @END Details • Permitted in local mode. • This command is only implemented for backwards compatibility. There is no real implementation of a list, only the list administration is updated.

  • Page 24: Add Sample

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.12 Add sample Description Introduces a sample Syntax Message @SAMPLE@ADD @SAMPLE_ID=<sample_id> @APPLICATION=<application_name> [@ARCHIVE=<archive_name>] @AT=<sample_position> [@UNIT=<unit_id>] [@UNLOADPOS=<sample_unload_position>] [@MEASURE=bool] @END Response @SAMPLE@ADD @SAMPLE_ID=<sample_id> @STATUS=<command_result> @END Details • Not permitted in local mode. • The sample is identiied by <sample_id>. •...
  • Page 25 CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE • @AT=<sample_position> is mandatory. • @UNIT is ignored in the command. • If a new sample is added to an already occupied <sample_position>, fatal will be returned. • If [@MEASURE=yes] and a measurement is active, the new measurement is added to the queue.

  • Page 26: Move Sample

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.13 Move sample Description Moves a sample Syntax Message @SAMPLE@MOVE @SAMPLE_ID=<sample_id> [@AT=<sample_position>] @TO=<sample_position> @END Response @SAMPLE@MOVE @SAMPLE_ID=<sample_id> @STATUS=<command_result> @END Details • Not permitted in local mode. • If the parameter [@AT=<sample_position>] is speciied, <sample_id> is ignored and <sample_position>...

  • Page 27: Remove Sample

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.14 Remove sample Description Removes a sample Syntax Message @SAMPLE@REMOVE @SAMPLE_ID=<sample_id> [@AT=<sample_position>] @END Response @SAMPLE@REMOVE @SAMPLE_ID=<sample_id> @STATUS=<command_result> @END Details • Not permitted in local mode. • If [@AT=<sample_position>] is speciied, <sample_id> is ignored and <sample_position> is used to locate the sample.

  • Page 28: Measure Sample

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.15 Measure sample Description Starts a measurement Syntax Message @SAMPLE@MEASURE @SAMPLE_ID=<sample_id> [@APPLICATION=<application_name>] @END Response @SAMPLE@MEASURE @SAMPLE_ID=<sample_id> @STATUS=<command_result> @END Details • Not permitted in local mode. • If [@APPLICATION=<application_name>] is speciied, the measurement application in the sample administration is updated before the measurement is started.

  • Page 29: Result Retrieval

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.5.16 Result retrieval Description Retrieves measurement results Syntax Message @RESULT @SAMPLE_ID=<sample_id> [@ARCHIVE=<archive_name>] @END Response 1 @RESULT @SAMPLE_ID=<sample_id> @STATUS=<result_status> [@TIME_STAMP=<date_time>] @APPLICATION=<application_name> @END Response 2 @RESULT @SAMPLE_ID=<sample_id> @STATUS=result_none @END Details • Permitted in local mode. • The response can also be sent as an event when the instrument status changes. •...
  • Page 30 CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE => @RESULT@SAMPLE_ID=sample2@ARCHIVE=wastebasket@END <= @RESULT@SAMPLE_ID=sample2@STATUS=result_none@TIME_STAMP=2019.05.10 10:34:45@APPLICATION=application_name@END Example 4 The sample is known in the sample administration, measured, no automatic analysis. => @RESULT@SAMPLE_ID=sample2@ARCHIVE=wastebasket@END <= @RESULT@SAMPLE_ID=sample2@STATUS=result_none@TIME_STAMP=2019.05.10 10:34:45@APPLICATION=application_name@END Example 5 The sample is known in the sample administration, measured, automatically analyzed. =>...

  • Page 31: Message Contents "Events)

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.6 Message contents (EVENTS) 3.6.1 Sample measured Description The measurement results are available after a sample is measured Syntax Event @SAMPLE@MEASURED @SAMPLE_ID=<sample_id> @STATUS=<command_result> @END...

  • Page 32: Sample Removed

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.6.2 Sample removed Description A sample is removed from the sample administration Syntax Event @SAMPLE@REMOVED @SAMPLE_ID=<sample_id> @AT=<sample_position> @END Details • This event is sent when a sample is removed from the sample administration.

  • Page 33: Sample Moved

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.6.3 Sample moved Description A sample is moved from one location to another Syntax Event @SAMPLE@MOVED @SAMPLE_ID=<sample_id> @AT=<sample_position> @TO=<sample_position> @END Details • This event is sent when a sample is moved from the @AT position to the @TO position. •...

  • Page 34: Messages

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.6.4 Messages Description Warnings and errors that are shown in the UAI are also sent to the host Syntax Event @MESSAGE=<message_nr> [@TIME_STAMP=<date_time>] @TYPE=<message_type> @DESCRIPTION=<message_text> @END Details • Issues are reported as UAI messages. • <message_nr>: The issue topic identiier. •...

  • Page 35: Data Dictionary

    CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE 3.7 Data dictionary Keyword Description <application_name> Name of the used measure application. <archive_name> The name of an archive. <bool> true false <command_result> normal Normal execution of the command fatal Command execution failed <date_time> YYYY.MM.DD HH:MM:SS <list_name>...
  • Page 36 CHAPTER 3 UNIVERSAL AUTOMATION INTERFACE Keyword Description <unit_mode> fatal A blocking system problem. This mode applies if there is an issue with level Error. warning A non-blocking problem. This mode applies if there is an issue with level Warning. move_out_req There is no fatal problem, but the system needs user support.

  • Page 37: Chapter 4 Troubleshooting

    CHAPTER 4 TROUBLESHOOTING 4.1 @STATUS=fatal Aeris responds with @STATUS=fatal when a command is given with a syntax error. 4.2 @STATUS=not_supported Aeris responds with @STATUS=not_supported when an unsupported command or unsupported parameter is given, or when a mandatory parameter is missing. Examples unsupported commands: =>...

Table of Contents

Save PDF