background image

Programming interface 

 

3.2 Communication via the programming interface 

 

SIMATIC RTLS4083T 

14

 

Operating Instructions, 12/2019, C79000-G8976-C527-02 

Configuration options of the programming interface 

The following properties can be configured for the transponder via the programming 

interface: 

 

Request a list showing all configured transponders of a Locating Manager Server. 

 

Activation of a "Themes" for the transponder including transfer of the texts / barcodes to 

be displayed 

 

Changing the contents of a form field of a transponder 

 

Query the current text or code and the current "Themes" 

 

Indication of the status of the "Control keys" used 

3.2

 

Communication via the programming interface 

General 

The communication of the programming interface is done via a WAMP-Router that is a 

component of the Locating Manager Server. Establishing a connection from an application to 

the Locating Manager Server requires the implementation of a WAMP client on the part of 

this application. There is no provision for client-specific parameterization. A connection can 

be terminated at any time using the WAMP client application.  

Properties of the coding 

The coding via the programming interface has the following properties: 

 

The data to be transferred for the data transport is transferred in the "JSON" format 

(JavaScript Object Notation). 

 

The text to be displayed is transmitted in "UTF-8" format (8-Bit UCS Transformation 

Format). 

 

Line breaks in text fields are managed using the "\r" element 

Содержание SIMATIC RTLS4083T

Страница 1: ...TIC RTLS Localization systems SIMATIC RTLS4083T Operating Instructions 12 2019 C79000 G8976 C527 02 Introduction 1 Device description 2 Programming interface 3 Installation Operation 4 Technical specifications 5 Approvals 6 ...

Страница 2: ...ly by personnel qualified for the specific task in accordance with the relevant documentation in particular its warning notices and safety instructions Qualified personnel are those who based on their training and experience are capable of identifying risks and avoiding potential hazards when working with these products systems Proper use of Siemens products Note the following WARNING Siemens prod...

Страница 3: ...play function key 10 2 4 Dimension drawing 11 3 Programming interface 13 3 1 Overview 13 3 2 Communication via the programming interface 14 3 3 RPC calls 16 3 4 Event messages 19 3 5 Code examples 21 3 6 Additional information 24 4 Installation Operation 25 4 1 Notes on installation 25 4 2 Operation 26 4 3 Cleaning and maintenance 26 4 4 Charging instructions 27 5 Technical specifications 29 6 App...

Страница 4: ...Table of contents SIMATIC RTLS4083T 4 Operating Instructions 12 2019 C79000 G8976 C527 02 ...

Страница 5: ...tructions These operating instructions apply to the following device RTLS4083T Further documentation The system manual Commissioning SIMATIC RTLS provides information on other SIMATIC RTLS products that you can operate together with the devices in this product line in an Industrial Ethernet network You can find the system manual at the following link See also Siemens Industry Online Support https ...

Страница 6: ... services that support you in every phase of the life of your machine or system from planning and implementation to commissioning through to maintenance and modernization You will find contact information on the Internet at the following address https www automation siemens com aspa_app ci yes lang en SITRAIN Training for Industry The training offer includes more than 300 courses on basic topics e...

Страница 7: ...s that may be implemented please visit https new siemens com global en company topic areas future of manufacturing industrial security html Siemens products and solutions undergo continuous development to make them more secure Siemens strongly recommends that product updates are applied as soon as they are available and that the latest product versions are used Use of product versions that are no ...

Страница 8: ...Introduction SIMATIC RTLS4083T 8 Operating Instructions 12 2019 C79000 G8976 C527 02 ...

Страница 9: ... the Locat ing Manager Server Information can be transmitted to the tran sponder via a programming interface on the Locating Manager and shown on the display Area of application The device is designed for an operating tem perature of 0 50 C If you only need localization without change of the display information the lower temperature limit can be lowered to 10 C The device is protected from water s...

Страница 10: ... flashing Table 2 3 LED status indicator LED Meaning Flashes green briefly when the F1 function key has been pressed Flashes green when the device is fully charged and in the charging station Lights green when the device is charging and is in the charging station Flashes red when the device is in the charging station and the battery is defective Remove the transponder from the charging station imm...

Страница 11: ...cription 2 4 Dimension drawing SIMATIC RTLS4083T Operating Instructions 12 2019 C79000 G8976 C527 02 11 2 4 Dimension drawing Figure 2 1 Dimension drawing SIMATIC RTLS4083T All dimensions specified in millimeters ...

Страница 12: ...Device description 2 4 Dimension drawing SIMATIC RTLS4083T 12 Operating Instructions 12 2019 C79000 G8976 C527 02 ...

Страница 13: ...onal functions of the transponder In addition to the basic function of its use as a localizable node the transponder offers additional functions such as ePaper display or Control keys which can be used by the external client applications The display content is managed via Themes A transponder Theme contains a background graphic and various form fields to display text and barcode A form field is a ...

Страница 14: ...ed 3 2 Communication via the programming interface General The communication of the programming interface is done via a WAMP Router that is a component of the Locating Manager Server Establishing a connection from an application to the Locating Manager Server requires the implementation of a WAMP client on the part of this application There is no provision for client specific parameterization A co...

Страница 15: ...n RTLS Locating Manager and RTLS408xT Red Communication between RTLS Locating Manager and RTLS408xT All RPC calls Remote Procedure Call received by the programming interface are answered immediately This means that there is no need to wait for an acknowledgment of the RPC call until the data transfer is completed The completion of the data transmission is confirmed by an event message provided for...

Страница 16: ...efore the previous value could be sent to the transponder only the value set last is transmitted to the transponder In this case only the writing of the last value is acknowledged by an event message The transmission of background images fonts and theme files is given higher priority and temporarily interrupts the transmission of text content 3 3 RPC calls Parameters of the RPC calls The following...

Страница 17: ...text length is invalid 0x0102 The text contains invalid characters or the characters are not supported Command Get Version This command queries the protocol version The default value is 1 URI agilion wls epaper get_version Parameter None Return value Consists of Version of the protocol type UInt32 Command Get Tags This command queries a list of all configured transponders in the Locating Manager S...

Страница 18: ...ype UInt32 Field with the following parameters FieldID type UInt32 Text type String Return value Consists of Result type UInt32 Field made of the following parameters RPCResult type UInt32 1 n FieldResults type UInt32 Command Get Display Theme This command outputs the current theme and the current texts and codes for a single transponder Only completely transmitted texts are returned If the curren...

Страница 19: ...ay Text Changed event message This event message is sent after the contents of a form field on the display have been changed Text is the content of this form field If the text is empty a problem with setting the text occurred URI agilion wls epaper display_text_changed Parameter Consists of TransponderID type UInt64 FieldID type UInt32 Text type String Button Pressed event message This event messa...

Страница 20: ...ey briefly pressed Event parameter ButtonDown 0 Function key pressed long 2 seconds Event parameter But tonDown 1 After a short or long press and subsequent heartbeat Event parame ter ButtonDown 0 1 Considered pressed OnShortButtonPress 1 Function key pressed short or long Event parameter ButtonDown 1 After a short or long press and subsequent heartbeat Event parame ter ButtonDown 0 The default va...

Страница 21: ...getheme session addr themeid param console log change zone for etag zoneid etag themeid addr var epapercmd parseInt addr 10 parseInt themeid 10 param if config debug console log send epapercmd epapercmd session call agilion wls epaper set_display_theme epapercmd then function res if config debug console log epaperapi response res Code Bedeutung 0x0000 No error 0x0011 TransponderID invalid 0x0012 T...

Страница 22: ... wamp name var connection new autobahn Connection url config wamp url realm config wamp realm max_retries 1 authmethods wampcra authid config wamp user onchallenge function session method extra if method wampcra return autobahn auth_cra sign config wamp key extra challenge connection onopen function session console log connected to wamp router config wamp name if config debug console info check ep...

Страница 23: ...e log no connection to wamp router config wamp name connection open Code example RPC calls pseudo code get_version RPC agilion wls epaper get_version In return value Version get_tags RPC agilion wls epaper get_tags In return value TransponderID ProductID FirmwareVersion TransponderID ProductID FirmwareVersion 34954 6021999 GANYMED_TY41_002 000 025 35319 6021999 GANYMED_TY41_002 000 025 set_display...

Страница 24: ...sponderID agilion wls epaper set_display_theme 12345 In return value result_code ThemeID FieldID text1 FieldID text2 3 6 Additional information You can find additional information on the subject of WAMP etc at LINK https wamp proto org LINK https crossbar io docs LINK https crossbar io autobahn LINK https github com crossbario autobahn js LINK https github com crossbario autobahn cpp ...

Страница 25: ...amaged during operation Protect the display from objects that could scratch or otherwise damage it The specified operating temperature ranges must be observed The device contains a lithium ion battery CAUTION Contact with the battery fluid Incorrect handling of the device may damage the battery and cause fluid to leak out of the battery Avoid contact with the battery fluid Rinse skin that comes in...

Страница 26: ...tion on this refer to section Programming interface Page 13 If the voltage is too low the device switches off automatically The device sends a Low power message to the Locating Manager The limit above which the device sends this message is configurable In this case the device must be fully recharged within 3 months to avoid deep self discharge and damage to the battery 4 3 Cleaning and maintenance...

Страница 27: ...e temperature the longer it takes to charge the device If the device exceeds 55 C during charging remove the device from the charging station Allow the device to cool down and try charging it again If the device becomes too hot again remove the device from the charging station and contact customer service The battery has a natural self discharge When stored in a state not fully charged the device ...

Страница 28: ...Installation Operation 4 4 Charging instructions SIMATIC RTLS4083T 28 Operating Instructions 12 2019 C79000 G8976 C527 02 ...

Страница 29: ...the localization 0 2 m Antennas Built in UWB antenna Bandwidth 499 2 MHz PHASE radio frequencies communication and optional localization Wireless method IEEE 802 15 4 Transmission speed 1 Mbit s Operating frequency rated value 2410 2480 MHz Transmit power Maximum 2 5 mW configurable Range Maximum 50 m Accuracy of the localization 1 m Antennas Built in 2 4 GHz antenna Bandwidth 2 MHz data transmiss...

Страница 30: ...t conditions Ambient temperature During operation During storage During transport During display operation During charging 10 50 C 10 50 C 10 50 C 0 40 C 10 40 C Design dimensions weights and connectors Dimensions L x W x H 95 x 62 x 13 mm Weight 85 g Degree of protection IP54 Method of securing Mounting clips Enclosure Plastic housing Color Titanium gray ...

Страница 31: ...cial journal of the EU L153 22 May 2014 pages 62 106 RoHS directive restriction of the use of certain hazardous substances The products described in these operating instructions meet the requirements of the EU directive 2011 65 EU on the restriction of the use of certain hazardous substances in electrical and electronic equipment Applied standard EN 50581 Technical documentation for the assessment...

Страница 32: ...a wideband UWB devices EN 55011 Industrial scientific and medical equipment Radio frequency disturbance characteristics Limits and methods of measurement EN 55032 Class A Class B Electromagnetic compatibility of multimedia equipment Emission requirements EN 55035 Electromagnetic compatibility of multimedia equipment Immunity requirements EN 61000 6 1 Electromagnetic compatibility EMC Part 6 1 Gene...

Страница 33: ... 2 Short Range Devices SRD using ultra wideband technology UWB Harmonized standard covering the essential requirements of article 3 2 of the Directive 2014 53 EU Part 2 Requirements for UWB location tracking Note The specified approvals are only valid if the corresponding symbol is printed on the device Mexico información La operación de este equipo está sujeta a las siguientes dos condiciones 1 e...

Отзывы: