Siemens SIMATIC RF1070R Operating Instructions Manual Download Page 43

Page: 43 / 58

Programming

6.4 Status codes

SIMATIC RF1000
Operating Instructions, 02/2019, C79000-G8976-C432-04

6.4

Status codes

The following table contains a list of the status codes of the VHL command set divided up

into command groups.

Table 6- 45 General status codes

Value

Variable

Description

USB

RS232

syscmd
0x0000 0x00

STATUS_OK

No error

vhl
0x0101 0x01

NOTAG_ERR

Transponder does not exist or no response.
This status code requires reselection of the

card with the function "vhl_select".

0x0102 0x02

CARD_NOT_SELECTED_ERR The function cannot be executed because

no transponder is selected.

0x0103 0x03

HF_ERR

Communications problems with the tran-

sponder.

0x0104 0x04

CONFIG_ERR

The structure of the VHL file is invalid or the

VHL file was not found.

0x0105 0x05

AUTH_ERR

Authentication error. The keys in the VHL

file are invalid (MIFARE) or the stamp in the

reader is invalid (LEGIC cards).

0x0106 0x06

READ_ERR

The communications sequence is success-

ful, but reading failed.

0x0107 0x07

WRITE_ERR

This value is currently not supported.

0x0108 0x08

CONFCARD_READ

A transponder was recognized.

0x0109 0x09

INVALID_CARD_FAMILY_ERR The required transponder type does not

match the transponder family of the current-

ly selected transponder.

0x010A 0x0A

NOT_SUPPORTED_ERR

The function is not supported.

0x010B 0x0B

VHL_FORMAT_ERR

Format error

0x010C 0x0C

VHL_HW_ERR

Hardware problems during access (e.g. on

the reader chip)

Autoread
0x0501 0x01

NO_MESSAGE_ERR

No valid card / no valid transponder recog-

nized.

0x0502 0x02

SCRIPT_RUNTIME_ERR

Runtime error detected during script execu-

tion.

0x0503 0x03

SCRIPT_SYNTAX_ERR

Syntax error in the script

0x0504 0x04

SCRIPT_NOT_IMPL_ERR

Scripts does not exist.

0x0510 0x10

AR_DISABLED_ERR

"Autoread" function is switched off.

Summary of Contents for SIMATIC RF1070R

Page 1: ...__ ___________________ ___________________ ___________________ SIMATIC Ident RFID systems SIMATIC RF1000 Operating Instructions 02 2019 C79000 G8976 C432 04 Introduction 1 Description 2 Installation 3 Connecting 4 Installing and commissioning 5 Programming 6 The demo application 7 Technical specifications 8 Dimension drawing 9 Appendix A ...

Page 2: ...only 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 pr...

Page 3: ...2 1 5 syscmd_get_info 21 6 2 1 6 syscmd_get_boot_status 22 6 2 1 7 syscmd_set_port 22 6 2 1 8 vhl_select 23 6 2 1 9 vhl_get_snr 25 6 2 1 10 vhl_is_selected 26 6 2 1 11 vhl_read 26 6 2 1 12 vhl_write 27 6 2 1 13 Autoread_SetMode 28 6 2 1 14 Autoread_GetMessage 30 6 2 1 15 Return values 31 6 3 Programming via the RS232 interface 32 6 3 1 Implementation of the system jobs 32 6 3 2 System jobs 32 6 3 ...

Page 4: ...C432 04 7 The demo application 45 7 1 User interface of the demo application 45 7 2 Create your own PC application via the USB interface 48 8 Technical specifications 51 9 Dimension drawing 53 A Appendix 55 A 1 Certificates approvals 55 A 2 Ordering data 57 A 3 Service Support 58 ...

Page 5: ...other names not identified by the registered trademark sign are registered trademarks of Siemens AG SIMATIC SIMATIC RF MOBY RF MANAGER and SIMATIC Sensors Recycling and disposal The products are low in harmful substances can be recycled and meet the requirements of the Directive 2012 19 EU for disposal of waste electrical and electronic equipment WEEE Do not dispose of the products at public dispo...

Page 6: ...ld only be connected to an enterprise network or the internet if and to the extent such a connection is necessary and only when appropriate security measures e g firewalls and or network segmentation are in place For additional information on industrial security measures that may be implemented please visit Link http www siemens com industrialsecurity Siemens products and solutions undergo continu...

Page 7: ...ATIC RF1060R RF1070R readers provide the option of using employee identification cards also when operating machines This allows finely graded access concepts to be implemented or user specific instructions zo be stored all with one card Figure 2 1 Product photo of the SIMATIC RF1060R and SIMATIC RF1070R readers Reader specific differences interfaces The SIMATIC RF1060R RF1070R readers are designed...

Page 8: ...nsponders Depending on the card type the serial number can be 4 7 or 10 bytes MIFARE ISO 14443 8 bytes ISO 15693 or 4 7 or 8 bytes LEGIC long If the SIMATIC RF1070R reader is operated via the RS232 interface programming takes place over the freeport protocol 2 2 Connection options and supported transponders Depending on the interface protocol used the readers can be used for various applications T...

Page 9: ...tralight C Serial number Serial number HID iClass Inside PicoPass Serial number Serial number NXP NTAG21x Serial number Serial number Reading the serial number as well as reading and writing the user memory area 1 Only for read only access Please note that serial numbers UIDs of transponders that begin with the byte 0x08 are always newly generated by the transponder This makes an assignment of ser...

Page 10: ...Description 2 2 Connection options and supported transponders SIMATIC RF1000 10 Operating Instructions 02 2019 C79000 G8976 C432 04 ...

Page 11: ... Mount the cover plate on the rear of the reader with the 4 Torx screws max 1 5 Nm 3 Tighten the 4 x stud screws max 0 5 Nm 4 If required mount the optional card holder on the front of the reader To do this place the card holder on the side of the reader housing and press it over the reader front so that the card holder locks in place Figure 3 1 Mounting the RF1060R RF1070R Note Minimum maximum th...

Page 12: ...ustrial environment installation in a cabinet or closed metal housing is recommended NOTICE Repair and maintenance Do not try to repair the reader in case of a problem Repair and maintenance work must only be carried out by qualified personnel Contact Siemens Support in case of repair or maintenance problems For more information refer to the section Service Support ...

Page 13: ... 2UH30 Connect the plug The procedure for connecting the reader depends on the interface over which the reader is being operated Connection via USB interface Proceed as follows to connect the SIMATIC RF1060R RF1070R reader via the USB interface 1 Connect the reader to the PC or Panel using the USB cable Connection via RS232 interface Proceed as follows to connect the SIMATIC RF1070R reader via the...

Page 14: ...signment of the cable 6GT2891 2UH30 Wire color Assignment red 5 V orange Data line TxD brown Data line RxD black GND Application example The following picture shows an example of an application of the SIMATIC RF1060R in conjunction with a SIMATIC HMI Figure 4 1 Example of an application of a SIMATIC RF1060R in conjunction with a SIMATIC HMI e g 6AV7250 ODC03 0AH0 with extension unit e g 6AV7674 1L...

Page 15: ... exe You will find the file on the Internet on the pages of the Industry Online Support https support industry siemens com cs ww en view 109741590 3 Start the demo application by double clicking on the file AccessControlDemo exe 4 Program the reader using the demo application and the DLL functions You will find more information on the demo application in the section The demo application Page 45 In...

Page 16: ...files of a configuration card can be stored on a reader To change the configuration of a reader with the configuration card you must set the AllowConfig true tag when calling the function vhl_select and then hold the card into the antenna field of the reader After you have changed the configuration the reader automatically restarts After the restart you must set the AllowConfig tag back to false T...

Page 17: ...tion are stored in the reader A card that is located in the antenna field is selected with the vhl_select function You can read or write to a required memory area of the respective card with the functions vhl_read vhl_write Because there are multiple configurations VHL files on the reader the desired configuration is selected with the VHLFile tag Autonomous reading Autoread Prerequisite for autono...

Page 18: ... the DLL files in your application under Microsoft Windows 7 8 10 and use them to call the described functions directly 6 2 1 Functions of the DLL 6 2 1 1 brp_open_usb_session The function opens a connection to the reader via the USB interface and returns a session key that is required for all functions and continued communication via this connection If the connection was successfully established ...

Page 19: ...er size for the job and response telegrams Note that the buffer size is automatically set to the default value of 128 bytes after the restart Function call int brp_set_bufsize int Handle int TotalBufsize int SendBufsize int RecvBufsize Table 6 2 Description of the parameters Parameter Description brp_open_usb_session The parameter opens a connection to the reader via the USB interface Handle The s...

Page 20: ...terminates an existing USB connection that was established earlier Function call int brp_close_session int Handle Table 6 3 Description of the parameters Parameter Description brp_close_session This parameter terminates a connection Handle The session key returned by the function brp_open_usb_session Return value BRP_OK BRP_ERR_WRONG_HANDLE You will find more information on return values in the se...

Page 21: ...ype of firmware the version and the serial number of the reader Function call int syscmd_get_info int Handle char fws int Status Table 6 5 Description of the parameters Parameter Description syscmd_get_info The parameter reads out information about the firmware of the reader Handle The session key returned by the function brp_open_usb_session fws This parameter contains information on the type of ...

Page 22: ... Parameter Description sys cmd_get_boot_status The parameter returns a boot status value Handle The session key returned by the function brp_open_usb_session boot_status Each bit represents an internal component of the reader Status OK Return value You will find more information on return values in the section Return val ues Page 31 Note Value of boot status not equal to 0 If the function returns ...

Page 23: ...section Return val ues Page 31 Table 6 8 Values of the port_mask parameter Value LED color 0x0000 Off 0x0001 Lit green 0x0002 Lit red 0x0003 Lit orange 0x0004 Acoustic signal only for RF1070R 6 2 1 8 vhl_select With the help of this function you select a card located in the antenna field If successful the status OK is returned The type of the selected card is returned in the parameter CardType Wit...

Page 24: ...d 0x0020 bit 6 0x6X Reserved 0x0800 bit 12 0xCX LEGIC Prime only for RF1070R 0xFFFF 0xFF All card families Function call int vhl_select int Handle word CardTypeMask bool Reselect bool AllowConfig byte CardType int Status Table 6 10 Description of the parameters Parameter Description vhl_select With this parameter you select a card located in the antenna field Handle The session key returned by the...

Page 25: ...returned In this case an undefined serial number is returned Note that the least significant byte of the serial number is output first For RF200 RF300 readers the most significant byte is usually output first Function call int vhl_get_snr int Handle byte Snr byte Length int Status Table 6 11 Description of the parameters Parameter Description vhl_get_snr The parameter returns the serial number of ...

Page 26: ... card selected the last time the vhl_select function was executed is still or once again located in the an tenna field Handle The session key returned by the function brp_open_usb_session Status OK CARD_NOT_SELECTED_ERR You will find more information on the reader status in the section Status codes Page 43 Return value BRP_OK You will find more information on return values in the section Return va...

Page 27: ...ss Data Area in which the received data is stored max 65535 bytes Status OK CARD_NOT_SELECTED_ERR HF_ERR HW_ERR CONFIG_ERR AUTH_ERR READ_ERR You will find more information on the reader status in the section Status codes Page 43 Return value BRP_OK You will find more information on return values in the section Return val ues Page 31 6 2 1 12 vhl_write This function writes data to a memory area tha...

Page 28: ...ERR AUTH_ERR READ_ERR You will find more information on the reader status in the section Status codes Page 43 Return value BRP_OK You will find more information on return values in the section Return val ues Page 31 6 2 1 13 Autoread_SetMode This function controls the Autoread functionality during runtime The memory content of the cards that enter the antenna field of the reader is automatically r...

Page 29: ...devcode 0x05 cmdcode 0x00 param Buffer for the function parameters 0x00 The Autoread functionality is deactivated and VHL functions can be used 0x01 The Autoread functionality is permanently switched on There is a permanent check as to whether a card is located in the antenna field 0x02 The Autoread functionality is executed once as soon as a card enters the antenna field This is followed by a swi...

Page 30: ...r reads data from a transponder located in the antenna field of the SIMATIC RF1070R Handle The session key returned by the function brp_open_usb_session devcode 0x05 cmdcode 0x01 param param_len 0x00 timeout Time in ms until the action is aborted 100 is the recommended value Status OK ERR_NOMESSAGE ERR_AR_DISABLED You will find more information on the reader status in the section Status codes Page...

Page 31: ... BRP_ERR_IDLE The reader is waiting for a function 0x04 BRP_ERR_TIMEOUT The response time has been exceeded 0x05 BRP_ERR_CORRUPTED_FRAME A bad frame was detected 0x06 BRP_ERR_UNEXPECTED_FRAME An unexpected frame was detected 0x07 BRP_ERR_GENERAL_IO The underlying serial port has caused an error 0x08 BRP_ERR_BUFFER_OVERFLOW The reader sent more data than expected 0x09 BRP_ERR_NO_MORE_HANDLES There ...

Page 32: ... 115 2 kBd 6 3 1 Implementation of the system jobs The different jobs are described in more detail below Note that you must wait for the respective response telegram reader response time before you can send new request telegrams The parameter length is entered in Big Endian format and always refers to the user data as of byte 5 excluding the optional checksum All other data is output in Little End...

Page 33: ...time 50 ms Table 6 19 Request telegram Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x00 DevCode 2 0x04 CmdCode 3 4 0x00 Parameter length 0 bytes 5 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 20 Response telegram without errors Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x00 DevCode 2 0x04 CmdCode 3 0x29 Parameter length ...

Page 34: ...ptional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 22 Response telegram without errors Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x00 DevCode 2 0x05 CmdCode 3 0x04 Parameter length 4 bytes 4 0x00 5 8 0x00 Boot status 0x00 OK 9 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 6 3 2 4 syscmd_set_port Max reader response time 100 ms Table 6 23...

Page 35: ...sum 1 0x00 DevCode 2 0x07 CmdCode 3 0x00 Parameter length 0 bytes 4 0x00 5 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 6 3 2 5 vhl_select Max reader response time 3 s Table 6 25 Request telegram Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x01 DevCode 2 0x00 CmdCode 3 0x04 Parameter length 4 bytes 4 0x00 5 0xFF Mask for the card type e g 0xFFFF You can ...

Page 36: ...en the value 0x1C is set in byte 0 Table 6 27 Response telegram with errors Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x01 DevCode 2 0x00 CmdCode 3 0x01 Parameter length 1 byte 4 0x00 5 0x01 Status e g 0x01 NOTAG_ERR Possible status codes NOTAG_ERR HF_ERR HW_ERR CONFCARD_READ 6 0xXX Optional checksum BCC8 when the value 0x19 is set in byte 0 6 3 2 6 vhl_get_snr Max reader...

Page 37: ...XX Optional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 30 Response telegram with errors Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x01 DevCode 2 0x01 CmdCode 3 0x01 Parameter length 1 byte 4 0x00 5 0x02 CARD_NOT_SELECTED_ERR 6 0xXX Optional checksum BCC8 when the value 0x19 is set in byte 0 6 3 2 7 vhl_is_selected Max reader response time 3 s Table 6 31 Re...

Page 38: ...rs Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x01 DevCode 2 0x04 CmdCode 3 0x01 Parameter length e g 1 byte 4 0x00 5 0x02 CARD_NOT_SELECTED_ERR 6 0xXX Optional checksum BCC8 when the value 0x19 is set in byte 0 6 3 2 8 vhl_read Max reader response time 3 s Table 6 34 Request telegram Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x01 DevCode 2 0x02 C...

Page 39: ... in byte 0 Table 6 36 Response telegram with errors Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x01 DevCode 2 0x02 CmdCode 3 0x01 Parameter length e g 1 byte 4 0x00 5 0x06 Status e g 0x06 READ_ERR Possible status codes CARD_NOT_SELECTED_ERR HF_ERR HW_ERR CONFCARD_READ AUTH_ERR READ_ERR 6 0xXX Optional checksum BCC8 when the value 0x9C is set in byte 0 6 3 2 9 vhl_write Max...

Page 40: ...ut errors Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x01 DevCode 2 0x03 CmdCode 3 4 0x00 Parameter length 0 bytes 5 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 39 Response telegram with errors Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x01 DevCode 2 0x03 CmdCode 3 0x01 Parameter length e g 1 byte 4 0x00 5 0x03 Status ...

Page 41: ...x02 6 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 41 Response telegram without errors Byte Value Description 0 0x0C Without checksum 0x1C With checksum 1 0x05 DevCode 2 0x00 CmdCode 3 4 0x00 Parameter length 0 bytes 5 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 6 3 2 11 Autoread_GetMessage Max reader response time 100 ms Table 6 42 Request telegram...

Page 42: ...00 Message type 6 0x05 Message length e g 0x05 7 11 0x11 Data from the user memory e g 0x11 12 0xXX Optional checksum BCC8 when the value 0x1C is set in byte 0 Table 6 44 Response telegram with errors Byte Value Description 0 0x8C Without checksum 0x9C With checksum 1 0x05 DevCode 2 0x01 CmdCode 3 0x01 Parameter length 1 byte 4 0x00 5 0x01 Status e g 0x01 BRP_ERR_STATUS Possible status codes ERR_N...

Page 43: ...hentication error The keys in the VHL file are invalid MIFARE or the stamp in the reader is invalid LEGIC cards 0x0106 0x06 READ_ERR The communications sequence is success ful but reading failed 0x0107 0x07 WRITE_ERR This value is currently not supported 0x0108 0x08 CONFCARD_READ A transponder was recognized 0x0109 0x09 INVALID_CARD_FAMILY_ERR The required transponder type does not match the trans...

Page 44: ...fic status codes Value Variable Description 0x00 OK No error 0x40 CMD_WORK The job is currently being processed 0x41 INVAILD_CMD_ERR Invalid function Causes The function is not valid The parameters are invalid The response exceeds 255 bytes Missing configuration 0x42 ACCESS_DENIED_ERR Missing authentication 0x81 TIMEOUT_ERR The reader is currently in timeout 0x82 FRAME_ERR Invalid command from hos...

Page 45: ...gram your own user application The demo application includes all the functions described in the following sections and is fully functional This gives you the opportunity of testing your readers directly using the demo application Note Disclaimer of liability Note that Siemens AG accepts no liability for the demo application 7 1 User interface of the demo application Requirement To be able to work ...

Page 46: ...ctivating the acoustic signal RF1070R Clear Emptying the top display area Read Data Manual reading of the transponder data Write Data Manual writing of the transponder data Option buttons Check boxes Read SerNr auto Automatic reading of the serial number and the card type Read Data auto Automatic reading of the transponder data depending on the specific card type configuration Read Write man Manua...

Page 47: ...ata auto Automatic reading of the transponder data depending on the specif ic card type configuration The data is output in the bottom display area If no matching specific card type configuration is stored in the reader the error message 0x501 is output Read Write man Manual reading writing of the transponder data depending on the selected configuration file VHL file number as well as the start ad...

Page 48: ... read range The transponder is recognized Read out the serial number vhl_get_snr Signal the application that the transponder with the serial number x was recognized Check cyclically whether the transponder is still in the read range The transponder is no longer within the read range Signal the application that the transponder with the serial number x is no longer recognized 3 Terminate the connect...

Page 49: ...r brp_close_session The source code of the demo application can serve as an example for your own application Create your own Parameter assignment via configuration card application Follow the steps below to create your own application for parameter assignment of the reader using a configuration or identification card 1 Establish the connection to the reader brp_open_usb_session 2 Check whether a c...

Page 50: ...The demo application 7 2 Create your own PC application via the USB interface SIMATIC RF1000 50 Operating Instructions 02 2019 C79000 G8976 C432 04 ...

Page 51: ...ications Housing Material PC GF Color TI Gray Interfaces Interface to the communication module USB 2 0 RS232 115 2 kBd no parity 1 Antenna integrated Supply voltage current consumption power loss Power supply 4 6 to 5 25 V DC Current consumption typically 150 mA max 300 mA Permitted ambient conditions Ambient temperature During operation 25 to 55 C During transportation and storage 25 to 55 C Degr...

Page 52: ...rox 120 g Type of mounting Door installation 4 x stud screws slotted screws M4 x 20 Tightening torque 0 5 Nm 4 x Torx screws EJOT T10 x 10 Tightening torque 1 5 Nm Installation wall thickness 2 7 mm Cable length reader communications module 1 8 m USB connecting cable Display elements LED 3 colors Acoustic signal 1 Approvals CE FCC IC MTBF 28 years 1 Only in conjunction with the SIMATIC RF1070R rea...

Page 53: ...SIMATIC RF1000 Operating Instructions 02 2019 C79000 G8976 C432 04 53 Dimension drawing 9 Figure 9 1 Dimension drawing RF1060R RF1070R with optional card holder All dimensions in mm ...

Page 54: ...Dimension drawing SIMATIC RF1000 54 Operating Instructions 02 2019 C79000 G8976 C432 04 ...

Page 55: ...a particular installation If this equipment does cause harmful interference to radio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an ...

Page 56: ...IL AGÊNCIA NACIONAL DE TELECOMUNICAÇÕES Este produto está homologado pela ANATEL de acordo com os procedimentos regulamentados pelaResolução 242 2000 e atende aos requi sitos técnicos aplicados Para maiores informações consulte o site da ANATEL www analel gov br ANATEL IDs SIMATIC RF1060R 00860 17 04794 SIMATIC RF1070R 07881 18 04794 Este equipamento não tem direito à proteção contra interferência...

Page 57: ...ะอุปกรณ นี มีความสอดคล องตามมาตรฐานหรือข อกําห นดทางเทคนิคของ กสทช This telecommunication equipment conforms to the technical stand ards or requirements of NBTC A 2 Ordering data Table A 2 Ordering data RF1060R Product Article number SIMATIC RF1060R 6GT2831 6AA50 SIMATIC RF1070R 6GT2831 6BA50 Table A 3 Ordering data accessories Product Article number Card holder for RF1060R RF1070R 6GT2890 0CA00 C...

Page 58: ...ion to commissioning through to maintenance and modernization You will find contact data on the Internet at the following address Link 3 http w3 siemens com aspa_app RFID homepage For general information about our identification systems visit RFID home page http w3 siemens com mcms identification systems Online catalog and ordering system The online catalog and the online ordering system can also ...

Search results

Summary of Contents for SIMATIC RF1070R

Reviews:

Related manuals for SIMATIC RF1070R

Brands by name

Popular brands

Siemens SIMATIC RF1070R, Operating Instructions Manual

Search results

Summary of Contents for SIMATIC RF1070R

Reviews:

Related manuals for SIMATIC RF1070R

Brands by name

Popular brands