background image

 

Programming interface 

 

4.1 The functions of the DLL 

SIMATIC RF1060R 
Operating Instructions, 05/2017, C79000-G8976-C432-02 

17

 

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 function "brp_open_usb_session()". 

CardTypeMask 

The parameter specifies a card family to be recognized. If you want all card 

families to be recognized, set the parameter to the value "0xFFFF". 

Reselect 

The parameter decides whether the card should be reselected. 

AllowConfig 

This value is always "false". 

CardType 

The returned value indicates the card type. 

Status 

You will find more information on the reader status in the section "Status 

codes (Page 19)"

Return value 

 

BRP_OK 

You will find more information on return values in the section "Return val-

ues (Page 18)"

4.1.8

 

vhl_get_snr 

The function returns the serial number of the currently selected card. If the function 

"vhl_select" could not be executed earlier or the card is no longer in the field, the value 

"CARD_NOT_SELECTED_ERR" (Status-Code "0x0102") is returned. In this case, an 

undefined serial number is returned. 

Function call 

int 

vhl_get_snr( 

  int Handle, 

  byte * Snr,  

  byte * Length,  

  int * Status 

); 

Description of the parameters 

 

Parameter 

Description 

vhl_get_snr 

The parameter returns the serial number of the currently selected card. 

 

Handle 

The session key returned by the function "brp_open_usb_session()". 

Snr 

Serial number of the card 

Length 

Length of the serial number in bytes 

Status 

You will find more information on the reader status in the section "Status 

codes (Page 19)"

Return value 

 

BRP_OK 

 

CARD_NOT_SELECTED_ERR 

You will find more information on return values in the section "Return val-

ues (Page 18)"

Summary of Contents for SIMATIC RF1060R

Page 1: ...___________ ___________________ ___________________ SIMATIC Ident RFID systems SIMATIC RF1060R Operating Instructions 05 2017 C79000 G8976 C432 02 Introduction 1 Installation 2 Installing and commissioning 3 Programming interface 4 Technical specifications 5 Dimension drawing 6 Appendix A ...

Page 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...

Page 3: ...4 1 3 syscmd_reset 13 4 1 4 syscmd_get_info 13 4 1 5 syscmd_get_boot_status 14 4 1 6 syscmd_set_port 15 4 1 7 vhl_select 16 4 1 8 vhl_get_snr 17 4 1 9 vhl_is_selected 18 4 1 10 Return values 18 4 1 11 Status codes 19 4 2 The demo application 20 4 2 1 User interface of the demo application 20 4 2 2 Creating your own application 22 5 Technical specifications 23 6 Dimension drawing 25 A Appendix 27 A...

Page 4: ...Table of contents SIMATIC RF1060R 4 Operating Instructions 05 2017 C79000 G8976 C432 02 ...

Page 5: ...ark sign are registered trademarks of Siemens AG SIMATIC SIMATIC RF MOBY RF MANAGER and SIMATIC Sensors Description Companies have been using RFID based identification card systems for years to control access to buildings With the increasing need for security and growing requirements for documentation solutions are demanded with which access to machines and plants can be controlled on a user basis...

Page 6: ...ns exist and how you use them is described in this manual Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants systems machines and networks In order to protect plants systems machines and networks against cyber threats it is necessary to implement and continuously maintain a holistic state of the art industrial...

Page 7: ...ount 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 Note Maximum thickness of the mounting wall The thickness of the ...

Page 8: ...reader in an industrial environment installation in a cabinet or closed metal housing is recommended The following picture shows an example of an application of the SIMATIC RF1060R in conjunction with a SIMATIC HMI Figure 2 2 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 1LA61 0AA0 ...

Page 9: ...device was installed successfully appears 2 Install DLL drivers and the demo application on your PC using the installation file RF1060R 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 You will find more information on th...

Page 10: ...Installing and commissioning SIMATIC RF1060R 10 Operating Instructions 05 2017 C79000 G8976 C432 02 ...

Page 11: ...d execution of the functions 4 1 The functions of the DLL 4 1 1 brp_open_usb_session The function opens a connection to the reader via USB and returns a session key that is required for all functions and continued communication via this connection If the connection was successfully established the value BRP_OK is returned Note that all the following functions can only be executed after you have es...

Page 12: ..._ERR_BUSY BRP_ERR_GENERAL_IO BRP_ERR_BUFFER_OVERFLOW BRP_ERR_NO_MORE_HANDLES BRP_ERR_INSUFFICIENT_MEM You will find more information on return values in the section Return val ues Page 18 4 1 2 brp_close_session This function terminates an existing USB connection that was established earlier Function call int brp_close_session int Handle Description of the parameters Parameter Description brp_clos...

Page 13: ... Description syscmd_reset The parameter restarts the reader Handle The session key returned by the function brp_open_usb_session Status You will find more information on the reader status in the section Status codes Page 19 Return value BRP_OK You will find more information on return values in the section Return values Page 18 4 1 4 syscmd_get_info The function reads out information about the firm...

Page 14: ...ore information on return values in the section Return val ues Page 18 4 1 5 syscmd_get_boot_status The function returns a boot status Each bit of the value returned by the function represents an internal component of the reader If the component of the reader could not be initialized the corresponding bit is set Check the value of boot_status for the value 0 and output an error or a warning if the...

Page 15: ...s You will find a list of possible LED colors in the following table Function call int syscmd_set_port int Handle word port_mask int Status Description of the parameters Parameter Description syscmd_set_port The parameter sets the LED of the reader Handle The session key returned by the function brp_open_usb_session port_mask Each value of the parameter is assigned to a certain LED color Status Yo...

Page 16: ...rently selected card is changed to the Hold mode and VHLSelect returns the value NOTAG_ERR If you want to select a card again without removing it physically from the antenna field you need to set the Reselect parameter to TRUE The CardTypeMask parameter allows only specific card families to be selected If you want to select all cards supported by the hardware of the reader you need to set the para...

Page 17: ... will find more information on return values in the section Return val ues Page 18 4 1 8 vhl_get_snr The function returns the serial number of the currently selected card If the function vhl_select could not be executed earlier or the card is no longer in the field the value CARD_NOT_SELECTED_ERR Status Code 0x0102 is returned In this case an undefined serial number is returned Function call int v...

Page 18: ...the function brp_open_usb_session Status You will find more information on the reader status in the section Status codes Page 19 Return value BRP_OK You will find more information on return values in the section Return val ues Page 18 4 1 10 Return values The following table contains a list of the possible values that the reader can return for the various functions Value Variable Description 0x00 ...

Page 19: ... transponder 0x0104 CONFIG_ERR This value is currently not supported 0x0105 AUTH_ERR This value is currently not supported 0x0106 READ_ERR The communications sequence is successful but read ing failed 0x0107 WRITE_ERR This value is currently not supported 0x0108 CONFCARD_READ A transponder was recognized 0x0109 INVALID_CARD_FAMILY_ERR The required transponder type does not match the transponder fa...

Page 20: ...n serves as a model on the basis of which you can program 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 4 2 1 User interface ...

Page 21: ...ders in the anten na field Stopp Scan Stop scanning Clear Clear the display window Figure 4 1 Start window of the demo application The demo application has 3 buttons and a display area The version number of the demo application is shown at the bottom right in the application 2 Start scanning by clicking the Start Scan button Figure 4 2 Sample view of a scan The acquired data is displayed in the di...

Page 22: ...o create your own application 1 Establish the connection to the reader brp_open_usb_session 2 Check cyclically whether a transponder is located in the read range of the reader vhl_select There is transponder in the 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 whet...

Page 23: ...ons Housing Material PC GF Color TI Gray Interfaces Interface to the communication module USB 2 0 Antenna integrated Supply voltage current consumption power loss Power supply 5 VDC via USB 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 Degree of protection to EN 60529 In the ...

Page 24: ...m Incl card holder 99 62 34 6 mm Weight approx 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 maximum 7 mm Cable length reader communications module 1 8 m USB connecting cable Display elements 3 color LED display Approvals CE FCC IC MTBF 28 years ...

Page 25: ...SIMATIC RF1060R Operating Instructions 05 2017 C79000 G8976 C432 02 25 Dimension drawing 6 Figure 6 1 Dimension drawing RF1060R with optional card holder All dimensions in mm ...

Page 26: ...Dimension drawing SIMATIC RF1060R 26 Operating Instructions 05 2017 C79000 G8976 C432 02 ...

Page 27: ... 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 28: ... d Industrie Canada appli cables aux appareils radio exempts de licence L exploitation est autorisée aux deux conditions suivantes 1 l appareil ne doit pas produire de brouillage 2 l appareil doit accepter tout brouillage radioélectrique subi même si le brouillage est susceptible d en compromettre le fonc tionnement Russia Belarus and Kazakhstan Brazil ANATEL 00860 17 04794 Este equipamento opera ...

Page 29: ... C79000 G8976 C432 02 29 A 2 Ordering data Table A 2 Ordering data RF1060R Product Article number SIMATIC RF1060R 6GT2831 6AA50 Table A 3 Ordering data accessories Product Article number Card holder for RF1060R 6GT2890 0CA00 Optional USB connecting cable 0 5 m 6GT2891 0UE50 ...

Page 30: ...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 ...

Reviews: