Siemens SIMATIC RF1060R User manual

___________________
___________________
___________________
___________________
___________________
___________________
___________________
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

Siemens AG
Division Process Industries and Drives
Postfach 48 48
90026 NÜRNBERG
GERMANY
Ⓟ
05/2017 Subject to change
Copyright © Siemens AG 2017.
All rights reserved
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated 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 products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.

SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 3
Table of contents
1 Introduction............................................................................................................................................. 5
2 Installation .............................................................................................................................................. 7
3 Installing and commissioning................................................................................................................... 9
4 Programming interface.......................................................................................................................... 11
4.1 The functions of the DLL.........................................................................................................11
4.1.1 brp_open_usb_session ...........................................................................................................11
4.1.2 brp_close_session...................................................................................................................12
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.1 Certificates & approvals..........................................................................................................27
A.2 Ordering data ..........................................................................................................................29
A.3 Service & Support ...................................................................................................................30

Table of contents
SIMATIC RF1060R
4Operating Instructions, 05/2017, C79000-G8976-C432-02

SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 5
Introduction
1
Purpose of these operating instructions
This documentation provides you with an overview of the installation and programming of the
SIMATIC RF1060R reader. The operating instructions are intended for users and
programmers involved in configuration, commissioning and servicing of the SIMATIC
RF1060R.
Registered trademarks
The following and possibly other names not identified by the registered trademark 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. The SIMATIC RF1060R reader provides 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 1-1 Product photo of the SIMATIC RF1060R

Introduction
SIMATIC RF1060R
6Operating Instructions, 05/2017, C79000-G8976-C432-02
The SIMATIC RF1060R is a reader for connection to a Windows based computer. The
connection is via a USB interface of the computer. The SIMATIC RF1060R is handled by the
computer like a keyboard. This makes it unnecessary to install specific RFID drivers.
On the Siemens support page "Industry Online Support
(https://support.industry.siemens.com/cs/ww/en/view/109741590)" there are functions for
accessing the reader in the form of a DLL file with a demo application. With the help of this
DLL file you can implement user identification for access to your own applications quickly
and simply. To do this, the reader reads out the serial numbers of MIFARE and ISO 15693
transponders. Depending on the card type, the serial number can be 4, 7 or 10 bytes long
(MIFARE / ISO 14443)or 8 bytes (ISO 15693).
Please note that serial numbers of transponders that begin with the byte "0x08" are always
newly generated by the transponder. This makes an assignment of serial numbers and
transponders impossible.
The reader can be addressed and controlled by functions, for example to change the status
of the reader or to communicate with a transponder. With the aid of the functions, you can for
example control the three-color reader LED. Which functions 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
security concept. Siemens’ products and solutions only form one element of such a concept.
Customer is responsible to prevent unauthorized access to its plants, systems, machines
and networks. Systems, machines and components should only be connected to the
enterprise network or the internet if and to the extent necessary and with appropriate security
measures (e.g. use of firewalls and network segmentation) in place.
Additionally, Siemens’ guidance on appropriate security measures should be taken into
account. For more information about industrial security, please visit
Link: (http://www.siemens.com/industrialsecurity)
Siemens’ products and solutions undergo continuous development to make them more
secure. Siemens strongly recommends to apply product updates as soon as available and to
always use the latest product versions. Use of product versions that are no longer supported,
and failure to apply latest updates may increase customer’s exposure to cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS
Feed under
Link: (http://www.siemens.com/industrialsecurity).

SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 7
Installation
2
Proceed as follows to install the RF1060R reader:
1. Push the reader through the mounting opening intended for this purpose (76 × 48 ± 0.3
mm) ①.
Make sure that the reader locks in place so that it cannot fall out,
2. 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.
Note
Maximum thickness of the mounting wall
The thickness of the wall on which the reader is
mounted may be a maximum of 7 mm.
Figure 2-1 Mounting the RF1060R

Installation
SIMATIC RF1060R
8Operating Instructions, 05/2017, C79000-G8976-C432-02
Application example
Note
Installation in a cabinet or metal housing
When operating the 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)

SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 9
Installing and commissioning
3
Proceed as follows to install and commission the SIMATIC RF1060R reader:
1. Connect the RF1060R reader to your PC using the USB cable.
Reaction: The message "A USB 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 the demo application in the section "The demo application
(Page 20)".

Installing and commissioning
SIMATIC RF1060R
10 Operating Instructions, 05/2017, C79000-G8976-C432-02

SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 11
Programming interface
4
General information
On the Siemens support page "Industry Online Support
(https://support.industry.siemens.com/cs/ww/en/view/109741590)" you will obtain the file
"RF1060R.zip". This contains access functions as a DLL file and a demo application that
illustrates the use of the DLL file.
With the demo application "AccessControlDemo" you can address the RF1060R directly
from your application via the USB interface.. A precompiled DLL file for Windows systems
that provides this function is included in the package.
The DLL makes various functions for communication with the reader available for integration
in your application. The reader has return values and status codes to inform you of the
reader status and 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 established a
connection to the reader with the function "brp_open_usb_session". If this is not the case, an
error is signaled back.
Note
Parallel operation not possible
Note that with the application, a connection can only be established to one reader at any one
time. For this reason "
brp_open_session" may only be called up once and before it can be
called again must first be closed by the function "brp_close_session".
After a "brp_open_session" the parameter "Handle" must always be = "0". If the parameter
≠
"0", there is either an error or the function "brp_open_session" was called up several times in
succession.

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
12 Operating Instructions, 05/2017, C79000-G8976-C432-02
Function call
int
brp_open_usb_session(
int * Handle,
DWORD ProductID
);
Description of the parameters
Parameter
Description
brp_open_usb_session
The parameter opens a connection to the reader via USB
Handle
Session key initialized by this function.
ProductID
The product ID of the device to be connected.
Return value •BRP_OK
•BRP_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_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 section "Return values
(Page 18)".

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 13
4.1.3
syscmd_reset
This function restarts the reader.
Note that after the function "syscmd_reset" you need to execute the function
"brp_close_session" followed by "brp_open_usb_session".
Function call
int
syscmd_reset (
int Handle,
int * Status
);
Description of the parameters
Parameter
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 firmware of the reader.
The value read out contains information on the type of firmware, the version and the serial
number of the reader.
Function call
int
syscmd_get_info(
int Handle,
char * fws,
int * Status
);

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
14 Operating Instructions, 05/2017, C79000-G8976-C432-02
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 firmware, the version
and the serial number of the reader.
Format: xx...xx r.rr.rr dd/dd/dd ssssssss
xx...xx
Firmware type
r.rr.rr
Version (major release, minor release, build ID)
dd/dd/dd
Date of the version
ssssssss
Serial number of the reader
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.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
values do not match.
Function call
int syscmd_get_boot_status(
int Handle,
dword * boot_status,
int * Status
);
Description of the parameters
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 You will find more information on the reader status in the section "Status
codes (Page 19)".
Return value You will find more information on return values in the section "Return val-
ues (Page 18)".

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 15
Note
Value of boot status not equal to "0"
If the function returns a value not equal to "0", please contact "
Service & Support
(Page
30)".
4.1.6
syscmd_set_port
You can use this function to assign parameters to the LEDs of the reader.
This function switches the LEDs of the module. With the parameters "port-mask" and
"Status" you can assign the different reader statuses one of the 3 LED colors. 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 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)".
Table 4- 1 Values of the "port_mask" parameter
Value
LED color
0x0000
Off
0x0001
Green
0x0002
Red
0x0003
Orange

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
16 Operating Instructions, 05/2017, C79000-G8976-C432-02
4.1.7
vhl_select
With 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". Note that
specification of the card type is achieved with the serial number, the length of the serial
number and other information specified at the time of the selection phase. Since there is no
guarantee that the serial number is unique, the card type is also not necessarily correct.
With the "VHLSelect" function you can select the card located in the antenna field of the
reader. Whenever "VHLSelect" is called again, the currently 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 parameter to
"0xFFFF". The more significant half byte specifies the card family (1-6) while the less
significant half byte (X) refers to the recognized card type.
Table 4- 2 The different card types and their representation
CardTypeMask
CardType
Card family
0x0001 (bit 1)
0x1X
ISO 14443 A / mifare
0x0002 (bit 2) 0x2X Reserved
0x0004 (bit 3)
0x3X
ISO 15693
0x0008 (bit 4)
0x4X
ISO 14443 B
0x0010 (bit 5)
0x5X
Reserved
0x0020 (bit 6)
0x6X
Reserved
Function call
int
vhl_select(
int Handle,
word CardTypeMask,
bool Reselect,
bool AllowConfig,
byte * CardType,
int * Status
);

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)".

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
18 Operating Instructions, 05/2017, C79000-G8976-C432-02
4.1.9
vhl_is_selected
This function checks whether the card selected the last time the "vhl_select" function
executed is still or once again located in the antenna field. If the card is there, the status
"OK" is returned.
Note that this function always returns "CARD_NOT_SELECTED_ERR" when a card is
shown a card without the "vhl_select" function being executed first.
Function call
int
vhl_is_selected(
int Handle,
int * Status
);
Description of the parameters
Parameter
Description
vhl_is_selected This parameter checks whether the card selected the last time the
"vhl_select" function executed is still or once again located in the antenna
field.
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 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
BRP_OK
No error has occurred
0x01
BRP_ERR_STATUS
The reader has returned a status code that is ≠"0".
0x02
BRP_ERR_BUSY
The reader is currently processing a function.
0x03
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 is no free session key.

Programming interface
4.1 The functions of the DLL
SIMATIC RF1060R
Operating Instructions, 05/2017, C79000-G8976-C432-02 19
Value
Variable
Description
0x0A BRP_ERR_INSUFFICIENT_MEM There is not enough memory to generate a new
session key.
0x0B BRP_ERR_WRONG_HANDLE The specified session key does not exist.
0x0C
BRP_ERR_WRONG_PARAMETERS
The parameters of a function are incorrect.
4.1.11
Status codes
The following table contains a list of the status codes of the VHL command set.
Value
Variable
Description
0x0000 BRP_OK No error
0x0101 NOTAG_ERR Transponder does not exist or no response.
This status code requires reselection of the card with
the function "vhl_select".
0x0102 CARD_NOT_SELECTED_ERR The function cannot be executed because no tran-
sponder is selected.
0x0103
HF_ERR
Communications problems with the 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 family of the currently selected transpond-
er.
0x010A
NOT_SUPPORTED_ERR
This value is currently not supported.
0x010B VHL_FORMAT_ERR This value is currently not supported.
Most of the status codes listed in the table above do not require reselection of the
transponder. The only status code that deviates from this rule is "NOTAG_ERR" This
requires reselection of the transponder by the application.
The functions are constructed so that if execution fails, they are automatically repeated. This
compensates any communications problems that may occur, e.g. due to bad RF signal
quality as a result of external influences.

Programming interface
4.2 The demo application
SIMATIC RF1060R
20 Operating Instructions, 05/2017, C79000-G8976-C432-02
4.2
The demo application
The demo application contained in the file "RF1060R" helps you to understand the available
functions.
The available software package contains a demo application based on Windows .NET 3.5
including source code files. This demo application 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 of the demo application
Requirement
To be able to work with the demo application, .NET 3.5 must be installed on your PC and the
"RF1060R.exe" file needs to be installed on your PC.