RFID RCP2
Overview
Warning
This manual applies only to the firmware version v0.17 onwards. Inveo does not guarantee that the information contained in this document applies to previous firmware revisions.
Purpose of the device
The RCP2 is an advanced RFID reader designed for a wide range of applications such as industry, services, trade and logistics. Thanks to comprehensive functionality, the device will perform well as a machine log-in device, access control to rooms (eg. warehouses), part of a customer loyalty system or a working time recorder.
With support for various communication protocols, the user has full control over the reader, including the display, beeper and inputs and outputs. In addition, thanks to the built-in memory, the device allows storage and access to the list of stored logs. Due to the built-in memory, the reader can operate autonomously, without the need for an external server.
The reader supports SSL encryption, HTTPS, certificate control and emailing. A Wi-Fi enabled version is also available, providing flexibility for installation and integration into existing systems.
Changelog
1.0 6th May 2025
- Firmware revision v0.17
- Overview
- Device construction
- Network configuration
- Device configuration
- Managing cards and logs
- Communication protocols
- Factory settings, backup
- Warranty and manufacturer's liability
Device construction
Technical characteristics
| Parameter | Description |
|---|---|
| Power supply | RFID RCP2 – 10-24V DC 3,5mm screw terminal |
| RFID RCP2 PoE 802,3af – 10-24V DC 3,5mm screw terminal PoE: 33-57V PoE IEEE 802.3af |
|
| Power consumption | Max 2,5W (~200mA @ 12V) |
| Transponders | The following RFID RCP2 versions are available: Mif: Version supporting Mifare Classic® transponders Uni: Unique EM4100, EM4102 transponders HT2: HITAG 2 transponders Ico: Version dedicated for ICODE® transponders Read distance: up to 8cm Built-in memory: 5000 tags, 30 000 events |
| Inputs | - Amount of inputs: 2 - Input type: Normally Open (NO) |
| Outputs | - Amount of outputs: 2 - Output type: NO (relay), - Maximum load: 1A @ 30V DC |
| Communication | - Ethernet 10Mbps, RJ45 port - RS-485 port, Modbus RTU Wi-Fi (option) |
| Enclosure ingress protection | IP30 for RCP2 and RCP2 with buttons, IP65 for RCP2 with numerical keypad |
Because of different installation needs, the device does not have any mounting openings in the enclosure. Openings should be made by the customer anywhere in the rear section of the housing - this does not void warranty. Remember to use a proper cable gland in order to maintain the declared ingress protection.
Dimensions
- Version with a numerical keypad:
Connector description
- RS485 – Modbus RTU connector,
- LAN – LAN connection socket,
- Zworka RESET – Shorting the pins for 10-15 seconds will reset the module to factory settings,
- Battery holder
- RelayMode – Relay mode jumpers. In position 1-2 - NO relay output, position 2-3 - PWR output voltage is supplied from the power input (12-24VDC),
- OUT1 – Relay 1 connector,
- OUT2 – Relay 2 connector,
- IN1 – General purpose input No. 1,
- IN2 – General purpose input No. 2,
- +12V- – 12-24V DC module power supply input.
OUT1 and OUT2 outputs can operate in two modes:
- PWR mode – Configuration jumpers set in position 2-3 (as shown in the image below). In this mode, an activated relay will provide the output with the power supply voltage eg. 12V DC. If the reader is powered with 24V DC, 24V DC will be provided.
Warning
If the reader is powered with PoE 802.3af and does not have a supply connected to the power input, outputs OUT1 and OUT2 won't have any voltage supplied to them.
- Normally Open mode – Jumpers set in position 1-2 (as shown in the image below). In this mode an external power source is necessary.
Communication channels and general characteristics
RFID RCP2 general view
RFID RCP2 with buttons general view
RFID RCP2 with numerical keypad general view
The module communicates via LAN or RS485.
The following methods can be used to access the read RFID tag:
- Built-in WWW server, available from a standard web browser,
- HTTP/HTTPS in server mode,
- HTTP/HTTPS in client mode,
- Modbus TCP,
- Modbus RTU (RS485 or optional RS232),
- MQTT in client mode.
The module supports SSL encryption, HTTPS, certificate verification and e-mail messages.
Network configuration
After the initial power-up, it's needed to configure the device. It can be done in two ways, the simplest method is to use the Inveo Discoverer programme.
Changing the device's IP address - Discoverer programme
After running the Discoverer programme and searching for the appropriate device:
- Right-click the device,
- Click the Change settings button.
After the dialogue window is opened you can:
- Set the IP address, mask, gateway, DNS1/DNS2,
- Change the Host name.
Note
The device will be configured after the Change button is pressed.
If Remote Config is disabled (enabled by default), the device needs to be configured by changing the computer's subnet:
To enable remote configuration:
- Go to the Administration tab,
- In the Access configuration window, select Enable Remote Config.
Tip
After making changes, apply them using the Save button
Changing the computer's subnet address for configuration
During configuration without Discoverer programme, it's needed to change the subnet address of the computer on the same network.
To access the computer's network configuration, do one of the following:
- Press Win + R, type in
ncpa.cpl, and then press Enter, - Alternatively, go to:
Start → Control Panel → Network and Internet → Network and sharing center → Change adapter settings.
Then:
- Select the network connection,
- Right-click it and select Properties,
- After selecting this option, network connection configuration screen will appear,
Select Internet protocol version 4 (TCP/IPv4) and type in the following parameters:
Note
After applying the configuration with OK, start a web browser and type in the following address: 192.168.111.15. (Default user and password: admin/admin)
Configuring LAN and Wi-Fi
In the Administration / Network tab, it's possible to change the LAN (and WLAN - if available) parameters.
- MAC Address – Device's MAC address,
- DHCP – Enable/disable the DHCP service,
- IP – Device's IP address,
- Netmask – IP Subnet mask,
- Gateway – Network gateway,
- DNS1, DNS2 – DNS addresses.
The following additional wireless connection options are available in the device optionally equipped with Wi-Fi:
- MAC Address – Device's MAC address,
- Enable – Enable/disable Wi-Fi,
- DHCP – Enable/disable the DHCP service,
- IP – Device's IP address,
- Netmask – IP Subnet mask,
- Gateway – Network gateway,
- DNS1, DNS2 – DNS addresses.
- SSID – Wireless network name,
- Password – Wireless network access password,
- Encryption:
- Open,
- WEP,
- WPA-PSK,
- WPA2_PSK,
- WPA_WPA2_PSK,
- WPA3_PSK.
After making changes, apply them using the Save button.
Checking the network status
The device allows for preview of current LAN and WLAN network parameters. In the Administration / Network tab, click Show net status
This section contains the following information:
- IP – Current IP address,
- Mask – Network mask,
- Gateway – Network gateway,
- DNS1, DNS2 – DNS server addresses,
- SSID – Broadcast name of the WLAN, to which the device is connected.
- RSSI – Wi-Fi signal in dBm. Value of -110 indicates a no signal condition.
Device configuration
Home page and device status
The device's home page accessible with a web browser is the device's main user interface, allowing for quick access to important information about the current device condition. By default it's accessible by IP address 192.168.111.15, but the user has the ability to change this address in device's network settings.
The home page displays detailed information, such as:
- Input and output status,
- Operational parameters of the device.
After the tab is selected, the Status table will appear:
- Input 1 – Displays the current state of the first binary input,
- Input 2 – Displays the current state of the second binary input,
- Relay 1 – Informs about the current state of the relay output No. 1,
- Relay 2 – Informs about the current state of the relay output No. 2,
- Last read ID – Displays the ID of last read RFID tag in hexadecimal format (HEX),
- Number of read ID – Displays the number of RFID tags read since last device restart.
Warning
Functions may differ depending on the model. Some of them are available only in selected versions.
Thanks to the built-in WWW server, user can access the home page from anywhere within the local network, which simplifies management and device configuration.
Administration tab
The Administration tab in the device's user interface allows managing of key system settings, such as configuration of diagnostic services, time settings, network settings, firmware update, and changing the access password. The user also has the option to create a backup of current settings. The tab is divided into several sub-tabs, each offering specific functions.
Module name
In the Settings section, the user can assign a unique name to the device that can be used for identification purposes and easier network management.
The Enable Remote Config function enabling remote configuration has been described in the Network configuration chapter.
Changing the password
The user has the option to manage the safety of device access by changing the password. To do that:
- In the Current Password field, input the current password,
- In the New Password and Re-type Password, input the new password,
- Click Save to save the changes.
Time settings
In the Administration / Time section, date and time settings are located. The device is fitted with a Real Time Clock with a battery backup, which allows for correct time measurement even during electricity loss.
The Update Time button synchronizes the device's internal clock with the current PC time. The time zone can be selected form an expandable list. Clicking Daylight saving will force the use of summer and winter time.
SNTP time server
The device can act as an SNTP client. To configure the SNTP service, go to the Services / SNTP tab.
- Enable – Enable SNTP client,
- Server – IP address or domain name of the SNTP server,
- Poll time – Time server querying frequency.
Diagnostics, events
The module offers advanced diagnostic options, allowing for data logging and sending them to a Syslog server. The settings are available in the Administration / System Events tab.
Log Events to flash settings table allows the user to configure events, that are to be logged to flash memory.
- Enable – Enable events logging to flash memory,
- Log cards events – Log card events - independent of card memory,
- Log IO – Log input and output state changes,
- Log system events – Log system events eg. module shutdown, changes in time settings, reset, restart and configuration changes,
- Log network events – Log network events eg. establishing a Wi-Fi connection.
Logged data can be previewed by clicking System log. The Realtime diagnostic message link goes to the site with logs displayed in real-time.
Syslog
The device is able to forward data to a Syslog server. The user can choose what events will be sent. Configuration takes place in the Syslog Settings table located in the Administration / Syslog tab.
- Enable – Enable syslog client,
- Syslog filter:
- All – All events registered by the device are sent to the server,
- Filter – Only events selected in Log events to flash settings table are sent to the server.
Special
The Special tab is used for inputting special configuration parameters per customer's individual needs.
I/O Settings
The I/O Settings tab enables the configuration of device input and output related settings. The reader is equipped with two relay outputs and two potential-free digital inputs. The user has the ability to adjust relay operations and input configuration in accordance to application needs.
Digital input settings
- Input invert – Software change of default input state,
- Input action – Defines the action that will be undertaken when the input is activated:
- No action,
- Out 1 – Trigger the relay output No. 1,
- Out 2 – Trigger the relay output No. 2.
- Input filter - Allows defining a time (in ms) during which the device ignores short changes to input signal, treating them as interference. The value of 0 disables filtration, which introduces no delays.
Relay outputs configuration
- Out mode – Relay output operation mode:
- None – Software disabled relay control. The relay is inactive,
- Off – Permanent relay deactivation,
- On – Permanent relay activation,
- Toggle – Change of relay state to the opposite (activation if it was deactivated, or deactivation if activated),
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field.
- Out time – Time of relay activation for the On Period mode. The user can input a value in seconds, during which the relay will remain active,
- Out time long – Time of relay activation for the On Long Period mode. Sets the relay operation for a longer period of time,
- Out invert – Software change of relay state - default NO (Normally Open); selecting this option changes it to NC (Normally Closed).
The same settings apply to both inputs.
LCD display
For the reader fitted with an LCD screen, configuration of default text and card reaction is possible. Standby state text configuration is available in the I/O Settings tab, LCD section.
- LCD Backlight – Screen backlight time, the value of 0 disables the backlight permanently, -1 activates the backlight permanently,
- LCD Default Text – Standby state display text, the user can use the available list of variables,
- Show Clock – Option to display a clock in the first line of the display.
Only RCP2
The LCD screen can be configured to display the selected entry/exit mode.
- Text Entrance,
- Text Exit,
- Text Work,
- Text Private.
Numeric keypad
The Button tab in the RCP2 with a numeric keypad is used to configure and adapt the keypad operation to user's individual needs. The user can select several options that can affect the keypad operation and device communication.
- Sound – Allows for keypad sound signal activation/deactivation,
- Card Emulate – Enables/disables the function to treat codes inputted with the kepyad as RFID cards.
Additional functions available when HTTP Client function is enabled:
- HTTP Client Method – Allows selection of communication method: eg. GET, POST, and how the data will be transferred to an external server,
- HTTP Content Type – Allows definition of HTTP request content type, eg. JSON, XML, making integration with various systems easier,
- HTTP Client Request – Configuration of a HTTP request that will be sent after a key is entered. Thanks to this option, it is possible to, for example, send the code to an external server for verification or further processing.
Additional functions available when MQTT function is enabled:
- MQTT – Enable/disable data publishing via MQTT,
- MQTT Payload – Configures the data contents transferred via MQTT. The user can customize the information that will be sent to MQTT brokers after a code is entered or other keypad actions are performed.
Predefined variables
The user has access to a set of predefined variables that can be used during LCD text and various functions configuration:
%usr_name1%–namefield from the card database (empty if no record),%usr_name2%–surnamefield from the card database (empty if no record),%usr_id%– ID from the card database (value-1if no record),%uid%– UID number,%time%– Current device time,%date%– Current device date,%ts%– Current device timestamp,%mod_name%– Device name,%mod_model%– Device model,%eip%– Ethernet - IP address,%emac%– Ethernet - MAC address,%in1%– State of input No. 1,%in2%– State of input No. 2,%cnt1%– Counter value for input No. 1,%cnt2%– Counter value for input No. 2,%out1%– State of output No. 1,%out2%– State of output No. 2,%json_cardlogs%– Log table,%json_card%– Last state of applied card,%enter_state%(RFID RCP2)%enter_inout%– Function button: entry or exit (RFID RCP2),%enter_privwork%– Function button: privbate or official (RFID RCP2),%btn%– Last pressed button (RFID RCP2 with a numeric keypad only):- digits 0 – 9 – Subsequent numerical keys,
- C – ESC key,
- U – Arrow pointing up,
- D – Arrow pointing down,
- L – Arrow pointing left,
- R – Arrow pointing right,
- X – ENTER key.
Card Action
The Card Action section allows for detailed configuration of RFID reader's reaction for RFID tag application. On this page the user can configure different settings such as:
- Controlling relay outputs,
- Configuration of HTTP requests,
- Defining the contents of MQTT messages,
- Event logging settings,
- Displaying announcements on the display and LED indicator reactions,
- Controlling the buzzer.
Action settings
The main Card action tab, in which the reader reaction for card application and basic card service functions can be configured.
- Enable card log – Enable global card event logging. Different events that are to be logged should be configured individually,
- Action hold time – Time, after which the reader starts executing settings defined for Action hold card function.
- Swap id – Allows changing of the byte order in RFID card's UID number,
- Remove card timeout – The time after taking the card from the reader's reading field, after which Action remove card will be executed (0.1s),
- Lua script – Enable Lua script response for each action (option),
- Lua Editor – Allows access to the Lua script editor (option),
- Mifare Options – Additional Mifare card readout options (only Mif version):
- Read Mifare block – Enable block reading function,
- Block – Read block address,
- Auth key A/B – Authentication key selection (A or B),
- Key – Authentication key in HEX format - the key is saved in secure memory (write only). The key should be written only when a change is required. Default key: 6xff (FFFFFFFFFFFF),
- Override UID – Override card ID with read data,
- Override UID offset – Character that the data readout begins from.
The On new card action section specifies the reader's behaviour when a new RFID card is detected in the read area.
- Search card in database – Option disables the function of comparing the applied tag to an internal database and treats all tags as unknown,
- HTTP Client Method, HTTP Content type oraz HTTP Client request – See HTTP Client configuration and HTTP Client – card action event request,
- MQTT oraz MQTT payload – See MQTT Client.
- Wait for server reply:
- No – The device checks the card, and depending on the Search card in database goes to Action known card or Action unknown card tabs,
- Yes – When using the HTTP Client, the device waits for data from the server for up to 3 seconds. The user can set the wait signaling eg. an LCD text. After this function is enabled, additional settings will appear. In some situations, the HTTP server can have a delay in responding to the reader.
The Action on server requests section enables the user to define the reader's behaviour while waiting for a reply from server or while receiving it
- Wait for server reply,
- Action by HTTP status code – Automatic response depending on the HTTP response code received:
- Code 200: the reader will execute the settings in Action known card,
- Other codes: the reader will execute the settings in Action unknown card.
- HTTP Connection fail action – Reader waits 3 seconds for the server response:
- Disable – If the sever does not respond, do nothing,
- Enable – If the server does not respond, go to the Action known card or Action unknown card tab, depending on the Search card in database setting.
- LCD text – Message displayed when the card is applied,
- Sound – Sound signal:
- None,
- Accept,
- Reject,
- Tick – Short sound signal.
- Out 1/2 – Output 1/2 control:
- None – Skip,
- Off – Deactivate the relay output,
- On – Activate the relay output,
- Toggle – Change relay state to the opposite,
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field,
- On User period – Relay activation for a time defined in the Out User Time 1 field.
- Out User Time 1/2 – Relay No. 1 activation time for On User Period mode,
- LCD backlight:
- None – Skip,
- Off,
- On,
- Toggle – Invert state,
- On Period – Backlight activation for a time specified in the Lcd Backlight (IO Settings tab),
- On Long Period – Backlight activation for a time specified in the Out Time Long field (IO Settings tab),
- Blink – Backligh blink.
- LCD Text Timeout:
- 0 – Do not display text,
- -1 – Display text continuously until another message is recalled,
- other value – Text display time in seconds.
- Log event – Enable event logging for RFID tag application in protocol control mode.
Action known card
This tab allows defining reactions of the reader after a card stored in the device's memory is applied.
- LCD text – Message displayed when the card is recognized,
- Sound – Sound signal:
- None,
- Accept,
- Reject,
- Tick – Short sound signal.
- Out 1/2 – Output 1/2 control:
- None – Skip,
- Off – Deactivate the relay output,
- On – Activate the relay output,
- Toggle – Change relay state to the opposite,
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field,
- On User period – Relay activation for a time defined in the Out User Time 1 field.
- Out User Time 1/2 – Relay No. 1 activation time for On User Period mode,
- LCD backlight:
- None – Skip,
- Off,
- On,
- Toggle – Invert state,
- On Period – Backlight activation for a time specified in the Lcd Backlight (IO Settings tab),
- On Long Period – Backlight activation for a time specified in the Out Time Long field (IO Settings tab),
- Blink – Backligh blink.
- LCD Text Timeout:
- 0 – Do not display text,
- -1 – Display text continuously until another message is recalled,
- other value – Text display time in seconds.
- Log event – Enable event logging for known RFID tag application in protocol control mode.
Action unknown card
This tab allows defining reactions of the reader after a card that isn't saved or has been deactivated in the device's memory is applied.
- LCD text – Message displayed when the card is not recognized,
- Sound – Sound signal:
- None,
- Accept,
- Reject,
- Tick – Short sound signal.
- Out 1/2 – Output 1/2 control:
- None – Skip,
- Off – Deactivate the relay output,
- On – Activate the relay output,
- Toggle – Change relay state to the opposite,
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field,
- On User period – Relay activation for a time defined in the Out User Time 1 field.
- Out User Time 1/2 – Relay No. 1 activation time for On User Period mode,
- LCD backlight:
- None – Skip,
- Off,
- On,
- Toggle – Invert state,
- On Period – Backlight activation for a time specified in the Lcd Backlight (IO Settings tab),
- On Long Period – Backlight activation for a time specified in the Out Time Long field (IO Settings tab),
- Blink – Backligh blink.
- LCD Text Timeout:
- 0 – Do not display text,
- -1 – Display text continuously until another message is recalled,
- other value – Text display time in seconds.
- Log event – Enable event logging for unknown RFID tag application in protocol control mode.
Action hold card
This tab allows defining reactions of the reader for holding a card in the read area for time defined in the Action Hold time parameter (default 5 seconds). This time can be configured in the Card Action / Action settings section in the Main settings tab.
- LCD text – Message displayed on the screen if an RFID tag is held in range of the reader,
- Sound – Sound signal:
- None,
- Accept,
- Reject,
- Tick – Short sound signal.
- Out 1/2 – Output 1/2 control:
- None – Skip,
- Off – Deactivate the relay output,
- On – Activate the relay output,
- Toggle – Change relay state to the opposite,
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field,
- On User period – Relay activation for a time defined in the Out User Time 1 field.
- Out User Time 1/2 – Relay No. 1 activation time for On User Period mode,
- LCD backlight:
- None – Skip,
- Off,
- On,
- Toggle – Invert state,
- On Period – Backlight activation for a time specified in the Lcd Backlight (IO Settings tab),
- On Long Period – Backlight activation for a time specified in the Out Time Long field (IO Settings tab),
- Blink – Backligh blink.
- LCD Text Timeout:
- 0 – Do not display text,
- -1 – Display text continuously until another message is recalled,
- other value – Text display time in seconds.
- HTTP Client Method, HTTP Content type oraz HTTP Client request – See HTTP Client – card action event request,
- MQTT oraz MQTT payload – See MQTT Client,
- Log event – Enable event logging if an RFID tag is held in range of the reader.
Action remove card
This tab allows defining reactions of the reader the moment a card is removed from the read area.
- LCD text – Message displayed on the screen if an RFID tag is removed from the reader,
- Sound – Sound signal:
- None,
- Accept,
- Reject,
- Tick – Short sound signal.
- Out 1/2 – Output 1/2 control:
- None – Skip,
- Off – Deactivate the relay output,
- On – Activate the relay output,
- Toggle – Change relay state to the opposite,
- On period – Relay activation for a time defined in the Out Time field,
- On long period – Relay activation for a time defined in the Out Time Long field,
- On User period – Relay activation for a time defined in the Out User Time 1 field.
- Out User Time 1/2 – Relay No. 1 activation time for On User Period mode,
- LCD backlight:
- None – Skip,
- Off,
- On,
- Toggle – Invert state,
- On Period – Backlight activation for a time specified in the Lcd Backlight (IO Settings tab),
- On Long Period – Backlight activation for a time specified in the Out Time Long field (IO Settings tab),
- Blink – Backligh blink.
- LCD Text Timeout:
- 0 – Do not display text,
- -1 – Display text continuously until another message is recalled,
- other value – Text display time in seconds.
- HTTP Client Method, HTTP Content type oraz HTTP Client request – See HTTP Client – card action event request,
- MQTT oraz MQTT payload – See MQTT Client,
- Log event – Enable event logging if an RFID tag is removed from the reader.
Managing cards and logs
Card database
The RFID reader is equipped with internal memory for managing RFID cards. The user can add cards to the reader both manually and by importing a CSV file. Device's reaction may differ whether a card is in the reader's memory or not.
Managing RFID tags from a browser
Information
The Card Database tab in the user interface allows for manual adding, editing and erasing RFID tags from the device's memory.
Fill the Add user card table to add a new user:
- Name 1 – User's first name,
- Name 2 – User's last name,
- Card ID – Read RFID tag UID number,
- Get from last read – Function inputting last read RFID tag,
- Active – Enable the RFID tag in reader's memory - disabling this option will cause the tag to skip searching the memory.
- Add card – Add record to a temporary RFID tag list.
Tip
The Add Card button causes a creation of a temporary RFID tags list, which is not immediately saved to the non-volatile memory. If a tag has been added or a record amended, the Save button changes its colour to red, indicating the need to press it in order to save all data to the non-volatile memory.
RFID tags database from a CSV file
Located at the bottom of the Card Database page are options to download the current card database and to save it to the reader's memory.
Downloading and uploading the CSV file
- Link in the Download Card CSV File section allows the user to download the CSV file containing all RFID tags stored in the reader's internal memory.
- To upload a RFID card database to the device, make sure the CSV file structure is compliant with the template (CSV Example File).
uid;name;surname;userId;flag
23456678;Julia;Smith;1;1
12345678;Jack;Smith;2;1
- uid – RFID tag ID,
- name – Name field from the card database,
- userId – Unique user ID,
- flag – Value of active field from the card database.
RFID tags file (cards.csv):
uid;name;surname;userId;flag
23456678;Julia;Smith;1;1
12345678;Jack;Smith;2;0
23456678;Andrew;Smith;3;1
22345678;Saul;Smith;4;0
Internal RFID card database after the CSV file (cards.csv) shown above is uploaded:
Warning
Size limit: maximum size of the uploaded file is 200 kB, which translates to roughly 5000 users.
RFID tags database in the form of JSON an XML files
The internal card database can be downloaded in the form of JSON or XML files. To gain access to those files, refer to resources below:
/card.json– to download the card file in JSON format,/card.xml– to download the card file in XML format.
{
"card":[
{"uid":"12345678",
"name1":"John",
"name2":"Smith",
"userId":"1",
"flag":"1"}
,
{"uid":"87654321",
"name1":"Saul",
"name2":"Smith",
"userId":"2",
"flag":"1"}
,
{"uid":"87878787",
"name1":"Andrew",
"name2":"Smith",
"userId":"3",
"flag":"1"}
]
}
<card>
<entry>
<uid>12345678</uid>
<name1>John</name1>
<name2>Smith</name2>
<userId>1</userId>
<flag>1</flag>
</entry>
<entry>
<uid>87654321</uid>
<name1>Saul</name1>
<name2>Smith</name2>
<userId>2</userId>
<flag>1</flag>
</entry>
<entry>
<uid>87878787</uid>
<name1>Andrew</name1>
<name2>Smith</name2>
<userId>3</userId>
<flag>1</flag>
</entry>
</card>
- uid – RFID tag ID,
- name1 – name1 field from the card database,
- name2 – name2 field from the card database,
- userId – Unique user ID,
- flag – Value of active field from the card database.
Event logging
The device can register events related to applying, holding or removing the card from the reader read area. Event log is available:
- On the website,
- In CSV format,
- In XML format,
- In JSON format.
Activation of event logging is possible in the Card action page, Action settings tab, Main settings table.
- Enable card log – Activates the global event logging function. The events that are to be saved to the device's memory should be specified,
- Action hold time – The time after which the reader will start executing the actions assigned to the Action hold card function.
Rodzaje logowanych zdarzeń
- Action Known Card – Application of an RFID card stored in the reader's memory,
- Action Unknown Card – Application of an RFID card not stored or deactivated in the reader's memory,
- Action Hold Card – Holding an RFID card in the read area for minimum Action Hold Time,
- Action Remove Card – Removal of RFID card outside the read area,
- HTTP/MQTT Communication – Utilizing and control by HTTP or MQTT communication protocols, optionally after enabling Wait for Server Replay.
Logging activaton/deactivation: To activate or deactivate event loggine, go to the appropriate tab in Card Action and click Show More Options. The Log Event row allows the user to enable or disable logging of the selected event.
Events preview using the webpage
The event log is available on the Card logs page. The logs available via the webpage have the following format:
| Column | Description |
|---|---|
| 1 | Sequential number |
| 2 | Date and time of recorded event |
| 3 | Action flag – meaning dependent on value: - 1 – RFID tag read during protocol control (HTTP/...) - 2 – action for card stored in the device's memory - 4 – action for unknown/inactive card - 8 – action for hold card function - 16 – action for remove card function |
| 4 | Mode value – decimal total of events - consult table below |
| 5 | ID number of user in card memory. „-1” means a card is unknown or inactive |
| 6 | UID of a read RFID tag |
| 7 | Combined value of Name and Surname fields from card memory |
Mode value is the sum of a value assigned to the current input / output state:
| Input/Output state | Description | binary | dec | hex |
|---|---|---|---|---|
| LOG_OUT0 | Current state of output 0 | 0100 0000 0000 | 1024 | 400 |
| LOG_OUT1 | Current state of output 1 | 1000 0000 0000 | 2048 | 800 |
| LOG_IN0 | Current state of input 0 | 01 0000 0000 0000 | 4096 | 1000 |
| LOG_IN1 | Current state of input 1 | 10 0000 0000 0000 | 8192 | 2000 |
| Function button | Description | dec | hex |
|---|---|---|---|
| ENTER_FLAG_PRIVATE | private | 1 | 1 |
| ENTER_FLAG_WORK | official | 2 | 2 |
| ENTER_FLAG_IN | entry | 4 | 4 |
| ENTER_FLAG_OUT | exit | 8 | 8 |
| ENTER_FLAG_EXT | Application of card to the external reader | 16 | 10 |
Logs can be deleted by pressing Remove logs or with an HTTP command.
Viewing events with a CSV, XML lub JSON file
Logs can be downloaded in the form of CSV, XML or JSON files. Their structure is somewhat more extensive than the WWW view.
CSV log file structure – access by resource http://device_ip/data/log.csv
timestamp;time;date;action;user_id;uid;name1;name2;enter
1744008560;08:49:20;07.04.2025;2;1;61F3911B;John;Smith;1030
1744008563;08:49:23;07.04.2025;2;2;717AA11B;Jan;Kowalski;1030
1744008569;08:49:29;07.04.2025;2;2;717AA11B;Jan;Kowalski;1030
XML log file structure – access by resource http:/device_ip/data/log/xml
<logs>
<entry>
<action>2</action>
<timestamp>1744008560</timestamp>
<time>08:49:20</time>
<date>2025-04-07</date>
<userId>1</userId>
<uid>61F3911B</uid>
<name1>John</name1>
<name2>Smith</name2>
<mode>1030</mode>
</entry>
<entry>
<action>2</action>
<timestamp>1744008563</timestamp>
<time>08:49:23</time>
<date>2025-04-07</date>
<userId>2</userId>
<uid>717AA11B</uid>
<name1>Jan</name1>
<name2>Kowalski</name2>
<mode>1030</mode>
</entry>
<entry>
<action>2</action>
<timestamp>1744008569</timestamp>
<time>08:49:29</time>
<date>2025-04-07</date>
<userId>2</userId>
<uid>717AA11B</uid>
<name1>Jan</name1>
<name2>Kowalski</name2>
<mode>1030</mode>
</entry>
</logs>
JSON log file structure – access by resource http:device_ip/data/log/json
{
"logs": [
{
"action": 2,
"mode": 1030,
"ts": 1744008560,
"time": "08:49:20",
"date": "2025-04-07",
"userId": 1,
"uid": "61F3911B",
"name1": "John",
"name2": "Smith"
},
{
"action": 2,
"mode": 1030,
"ts": 1744008563,
"time": "08:49:23",
"date": "2025-04-07",
"userId": 2,
"uid": "717AA11B",
"name1": "Jan",
"name2": "Kowalski"
},
{
"action": 2,
"mode": 1030,
"ts": 1744008569,
"time": "08:49:29",
"date": "2025-04-07",
"userId": 2,
"uid": "717AA11B",
"name1": "Jan",
"name2": "Kowalski"
}
]
}
Logs can be deleted by pressing Remove logs or with an HTTP command.
Periodic card log transmission
It is possible to activate periodic sending of card logs via HTTP(S). After this option is enabled, the logs – if present – will be sent in specified time intervals.
The following settings should be configured in Services / HTTP Client:
- Send card log by HTTP(S) – Activation / deactivation of periodic log sending via HTTP(S), data is sent in packets of up to 4kB in a single request,
- Send card log period – Frequency of logs sending in minutes,
- Send card log request – Syntax of the request sent by the device according to Send card log period. Must contain the variable
%json_cardlogs%that recalls a table containing event logs.
If the Internet access is unavailable, the device will send the saved events in 4kB packets (around 26 events) after the connection is restored.
Example
Sample data packet:
{
device: 'RFID reader ABCD',
logs: [
{
action: '16',
mode: '0',
ts: '1682334001',
time: '13:00:01',
date: '2023-04-24',
userId: '6',
uid: 'AA81DD9B',
name1: 'Jack',
name2: 'Smith'
},
{
action: '2',
mode: '0',
ts: '1682333999',
time: '12:59:59',
date: '2023-04-24',
userId: '4',
uid: 'AB94DC5A',
name1: 'John',
name2: 'Smith'
}
]
}
{
"lcd_clr":0,
"lcd_text0":"Log packet transferred",
"cardlog_remove":12
}
After the reader receives this response, "Log packet transferred" will appear on the LCD. "cardlog_remove":12 causes the 12 oldest logs to be removed from the device's memory. If any data remains in the memory, it will be sent in the next packet automatically. Data transfer will continue until no logs remain in the memory or the received command does not contain cardlog_remove (in this case the reader will send the next log packet after the Send card log period time passes).
Communication protocols
The device supports various communication protocols that can be adapted to individual needs. The configuration is available in the Services tab.
HTTP/HTTPS Server
The reader can be configured as an HTTP or HTTPS server. In this mode, an external client connects with the reader and manages it with HTTP/HTTPS requests (GET method).
The client regularly downloads the status.xml or status.json file, which contains information about device condition such as:
- Card UID,
- Reader's MAC address,
- Input and output states.
After reading and decoding this data, the client can send commands to the reader, that will recall appropriate reactions, such as:
- Sound signalling (eg. card accepted/rejected),
- LED indicators flashing,
- Door lock release,
- Displaying text on the screen.
HTTP server configuration is available in the Services tab.
- HTTP port – HTTP server and device webpage access port,
- HTTPS port – HTTP server and device webpage access port (SSL/TLS encryption required),
- Block RFID read – Readout of a subsequent RFID tag is blocked until the reset flag is reset,
- SSL/TLS – Enable encrypted HTTPS connection support,
- SSL Key file (pem) – SSL key file location (pem format),
- Certificate file (pem) – CSR (Certificate Signing Request) file location (pem format).
HTTP GET – status
To get the current module status, recall the resource under the address: IP_address/data/status.xml or IP_address/data/status.json.
In response, the resource will be displayed in the form of an XML or JSON file, containing basic information about the reader:
Example response in XML format:
<status>
<model>RFID IND2</model>
<name>T</name>
<mac>00:00:00:00:00:00</mac>
<id>40005EB4F4</id>
<newId>1</newId>
<rfid_enable>1</rfid_enable>
<cnt>1</cnt>
<n_logs>1</n_logs>
<in1>0</in1>
<in2>0</in2>
<cnt1>0</cnt1>
<cnt2>0</cnt2>
<out1>0</out1>
<out2>0</out2>
<time>09:40:23</time>
<date>06-07-2022</date>
</status>
Example response in JSON format:
{
"model": "RFID IND2",
"name": "T",
"mac": "00:00:00:00:00:00",
"id": "40005EB4F4",
"newId": "40005EB4F4",
"rfid_enable": 1,
"cnt": 1,
"n_logs": 1,
"in1": 0,
"in2": 0,
"cnt1": 0,
"cnt2": 0,
"out1": 0,
"out2": 0,
"time": "09:55:33",
"date": "06-07-2022"
}
| Tag | Description |
|---|---|
| model | Device model |
| name | User-assigned module name |
| mac | Device MAC address |
| id | ID of the last RFID tag read |
| newId | Flag informing about new tag read - read flag |
| rfid_enable | RFID antenna status |
| cnt | Amount of read RFID tags since last device restart |
| n_logs | Current amount of logs in the device |
| in1 | Current state of input No. 0 |
| in2 | Current state of input No. 1 |
| cnt1 | Current counter value for input No. 0 |
| cnt2 | Current counter value for input No. 1 |
| out1 | Current state of relay output No. 0 |
| out2 | Current state of relay output No. 1 |
| time | Current device time |
| date | Current device date |
HTTP GET – control
Tip
All HTTP GET commands are mapped to XML/JSON tags for HTTP Client service
Warning
Special attention should be given to the correct order in which the commands are sent. For example: sending lcd_text[0-3] and then lcd_clr will clear the display. Correct order: lcd_clr, then lcd_text[0-3]
http://IPaddress/stat.php
| Command | Value | Description |
|---|---|---|
| open1 | INTEGER | Control of relay No. 1 in the mode defined in I/O Settings |
| open2 | INTEGER | Control of relay No. 2 in the mode defined in I/O Settings |
| out0 | INTEGER | Control of relay No. 1 in bistable mode |
| out1 | INTEGER | Control of relay No. 2 in bistable mode |
| text | STRING | Writes text to the LCD. A new line is started after 20 subsequent characters |
| lcd_text0 | STRING | Transcription of one LCD text line. Text line 1 |
| lcd_text1 | STRING | Transcription of one LCD text line. Text line 2 |
| lcd_text2 | STRING | Transcription of one LCD text line. Text line 3 |
| lcd_text3 | STRING | Transcription of one LCD text line. Text line 4 |
| lcd_clr | Clear LCD | |
| lcd_wrap | STRING | Transcription of the LCD text with wrapping |
| lcd_nowrap | STRING | Transcription of the LCD text without wrapping |
| lcd_word | STRING | Transcription of the LCD text with wrapping, text divided for entire words |
| lcd_text_timeout | INTEGER | Display text for a defined period of time |
| lcd_clock | 0 | 1 | Display or hide the clock, does not overwrite the webpage setting |
| bl | STRING | LCD backlight control on off int – time [s] |
| ledg | STRING | Green LED: on, off, int, int, int - TimeOn*0,1s, TimeOff*0,1s, CNT=255 - repeats endlessly example: "ledg":5,5,5 will activate the LED for 0,5s, deactivate for 0,5s and repeat the whole sequence five times. |
| ledr | STRING | Red LED. Similar to ledg |
| buzz | INTEGER | Sound emission: 1 – accept, 2 – reject, 3 - short signal example: "buzz":2 - buzzer will emit the card rejection sound signal. |
| userdb_store | INTEGER | Transcription of card data from RAM to FLASH. (1) This operation should be performed only after all user modifications have been made, and as rarely as possible. It should be noted that the amount of guaranteed memory write cycles is 10 000 |
| userdb_ver | STRING | Allows readout of card database stored in RAM (if the base is sent to the reader with HTTP Client). If the card database is updated dynamically or dependent on specified conditions, this command allows to monitor its version and to check if changes have been made. |
| enable | 0 | 1 | Enable or disable card reading |
| removeLogsN | INTEGER | Delete last n logs eg.: "removeLogsN":10 will delete 10 oldest logs |
| removeLogs | 1 | Delete all logs |
| releaseId | INTEGER | Release the newId flag (if block RFID read is enabled) |
| cardlog_remove_n | INTEGER | Delete last n card logs eg.: "cardlog_remove_n":4 will delete 4 oldest logs |
| cardlog_remove_all | 1 | Delete all logs |
| rfid_timeout | INTEGER | RFID antenna timeout after specified time |
Tip
Consecutive commands in HTTP GET are to be separated by "&".
HTTP GET – RFID card database
RFID cards can be edited, added or deleted by using HTTP commands.
Tip
After a power cycle, the reader transcribes the card data from flash memory to RAM
Warning
After all edits have been made, it's needed to write all data to the flash memory. The flash memory write procedure should be performed as rarely as possible.
Resource: http://IPaddress/card.cmd?
| Command | Value | Description |
|---|---|---|
| addCard | UID Name Surname ID Flag |
Add or modify card addCard=UID; Name;Surname;ID;flag - if id=-1: the reader will find an empty record and add the card to it - if id>0: the record exists in memory – edits the record; if the record does not exist – adds a record with specified ID. Returns in JSON: - -2 – operation failed – the UID is already in the database (only for id=-1) - -1 – operation failed - >0 – ID number that has been modified or added |
| getCardByUid | STRING | Returns a record with the card containing selected UID |
| getCardByUserId | INTEGER | Rerurns a record with the card containing selected user ID |
| removeCard | INTEGER | Deletes a card with the selected user ID |
| removeAllCards | INTEGER | Deletes all cards from the reader's memory |
| reloadCards | INTEGER | Re-read RFID cards from flash to RAM |
| storeCards | INTEGER | Write card data from RAM to flash |
HTTP Client
In the HTTP Client mode, the module operates similarly to a web browser – it initiates a connection with a server, sending requests and awaiting a reply.
Main features:
- Automatic data sending: After an RFID tag is read, the module automatically connects to the server and transfers information about the tag read,
- Receiving commands from the server: The server can send module control instructions such as: enable LED's, generate sounds, display text on the LCD screen,
- Easy integration: The mode allows easy integration with various server technologies such as PHP, Node.js or MySQL.
Benefits:
- Instantaneous communication: The module automatically initiates a connection after a card is read, allowing for quick data transfer to the server,
- Flexible control: The server can control different module elements in response to the commands sent.
HTTP Client configuration
HTTP Client can be configured in Services, HTTP Client tab.
- Enable – Enable the HTTP Client service,
- Server – IP address of a server the module initiates a connection with,
- HTTP port – Port, on which the server listens (default 80 for HTTP or 443 for HTTPS),
- HTTP Method – HTTP method used for communicating: GET, POST, PUT, DELETE,
- Content type – Header determining the type of transferred data (eg. text/plain, json, xml, form),
- Resource – Access path to a server resource the module communicates with,
- User – User name (if using server authentication),
- Password – User password (if using server authentication),
- HTTP ping server – Server query frequency (poll time),
- HTTP ping request – Server query request syntax (poll request).
- Send card log by HTTP(S) – Enable/disable periodic transfer of event logs via HTTP(S), data is sent in packets of up to 4kB per single request,
- Send card log period – Log transfer frequency in minutes,
- Send card log request – Syntax of the request sent by the device during Send card log period. Must contain the
%json_cardlogs%variable, recalling a table containing event logs (see Predefined variables).
For communication security, the device supports connection encryption.
- SSL/TLS – Enable encryption using SSL/TLS protocols,
- SSL root certificate – Enable use of CA ROOT for server verification,
- Skip cert CN check – Skip checking of CN (Common Name) field compatibility server certificate,
- Use Client certificate – Enable use of client certificate to authenticate on the server side,
- Client key password – Password securing the client key.
All certificate files required for establishing an encrypted connection can be transferred in the SSL Client Certificate section.
HTTP Client – poll request
The reader can periodically send poll requests to the server, in order to check the status or keep the connection open. The content of such request is defined in the HTTP Ping Request field on the Services / HTTP Client page.
The request can contain both static text and predefined variables, which allows for dynamic adaptation to its contents.
Example: Sending a "poll" request to the resource every 6 seconds:
- GET request using predefined variables
ip=%eip%&name=%mod_name%&in1=%in1%
Data received on the server side:
GET /resource?ip=192.168.0.176&name=Taw&in1=1 HTTP/1.1
User-Agent: Ind2
Host: 192.168.0.90
Content-Length: 0
The server can send data back in the form of a JSON (XML) file:
HTTP/1.1 200 OK
Content-Length: 33
Content-Type: application/json
{"lcd_text1":" Place an RFID tag"}
- POST request using predefined variables:
ip=%eip%
name=%mod_name%
in1=%in1%
Data received on the server side:
OST / HTTP/1.1
User-Agent: Ind2
Host: 192.168.0.90
Content-Type: application/x-www-form-urlencoded
Content-Length: 33
ip=192.168.0.176
name=Taw
in1=0
The server can send data back in the form of a JSON (XML) file:
HTTP/1.1 200 OK
Content-Length: 14
Content-Type: application/xml
<buzz>3</buzz>
HTTP Client – card action event request
Application of an RFID tag to the reader can trigger sending of a HTTP request to the configured server.
The Card Action page allows configuration of three HTTP request send triggers:
- On-new – Sends the request after each application of an RFID card to the reader,
- On-hold – Sends the request if the card is located in the read area for at least 5 seconds (hold time is set to 5 seconds by default),
- On-remove – Sends the request if the RFID tag is removed from the read area.
Information
Each scenario shown above operates independently, which allows the user to choose what events are to trigger HTTP requests. Additionally, the user can individually configure the request contents, its type and a method for each trigger.
The user configures the request content, its type and a method for each trigger separately.
HTTP request configuration parameters:
- HTTP method: – HTTP method used for communicating: GET, POST, PUT, DELETE,
- Content type – Type of header: (eg. text/plain, json, xml, form),
- HTTP request – HTTP request syntax. The user defines the full syntax of the request, adjusting it to the server needs (eg. dynamic data, predefined variables).
Tip
If the Search card in database option (Card Action, On new card action) is set to All like unknown, the reader will not search the internal card database. User variables will assume the values of an unknown card.
Example 1
For data from the screenshot and On new card action trigger:
HTTP Client request: mac=%emac%&ip=%eip%&id=%uid%
After a card is applied, data on the server side will look like this:
GET /?mac=00:00:00:00:00:00&ip=192.168.0.176&id=12005CB99F HTTP/1.1
User-Agent: Ind2
Host: 192.168.0.90
Content-Type: text/plain
Content-Length: 0
The server can return data in the form of a JSON (XML) file:
HTTP/1.1 200 OK
Content-Length: 41
Content-Type: application/json
{
"lcd_text1":" Welcome!",
"buzz":"3"
}
Example 2
Request: ip=%eip%&id=%uid%&czas=%time%&state=VARIABLE
VARIABLE assumes different values depending on the selected trigger
- On new card action → VARIABLE = put,
- Action hold card → VARIABLE = hold,
- Action remove card → VARIABLE = away.
For the HTTP request shown above, the server will receive the following data after an RFID card is applied to the reader for 10 seconds:
ip=192.168.0.176&id=12005EE365&czas=12:19:00&state=put //On new card action
ip=192.168.0.176&id=12005EE365&czas=12:19:05&state=hold //Action hold card
ip=192.168.0.176&id=12005EE365&czas=12:19:11&state=away //Action remove card
This HTTP request syntax allows for simultaneous reader control.
If using the reader with a card slot enclosure, the user will be registered in the system when a card is applied (put status). The hold status indicates that the card is present in the slot, granting access to a room / activating a device, while the remove status indicates a card removal action, canceling the authorization.
HTTP Client – control
Controlling the module in HTTP Client mode is possible after enabling HTTP Client in the Services tab.
| Command | Value | Description |
|---|---|---|
| open1 | INTEGER | Control of relay No. 1 in the mode defined in I/O Settings |
| open2 | INTEGER | Control of relay No. 2 in the mode defined in I/O Settings |
| out0 | INTEGER | Control of relay No. 1 in bistable mode |
| out1 | INTEGER | Control of relay No. 2 in bistable mode |
| text | STRING | Writes text to the LCD. A new line is started after 20 subsequent characters |
| lcd_text0 | STRING | Transcription of one LCD text line. Text line 1 |
| lcd_text1 | STRING | Transcription of one LCD text line. Text line 2 |
| lcd_text2 | STRING | Transcription of one LCD text line. Text line 3 |
| lcd_text3 | STRING | Transcription of one LCD text line. Text line 4 |
| lcd_clr | Clear LCD | |
| lcd_wrap | STRING | Transcription of the LCD text with wrapping |
| lcd_nowrap | STRING | Transcription of the LCD text without wrapping |
| lcd_word | STRING | Transcription of the LCD text with wrapping, text divided for entire words |
| lcd_text_timeout | INTEGER | Display text for a defined period of time |
| lcd_clock | 0 | 1 | Display or hide the clock, does not overwrite the webpage setting |
| bl | STRING | LCD backlight control on off int – time [s] |
| ledg | STRING | Green LED: on, off, int, int, int - TimeOn*0,1s, TimeOff*0,1s, CNT=255 - repeats endlessly example: "ledg":5,5,5 will activate the LED for 0,5s, deactivate for 0,5s and repeat the whole sequence five times. |
| ledr | STRING | Red LED. Similar to ledg |
| buzz | INTEGER | Sound emission: 1 – accept, 2 – reject, 3 - short signal example: "buzz":2 - buzzer will emit the card rejection sound signal. |
| userdb_store | INTEGER | Transcription of card data from RAM to FLASH. (1) This operation should be performed only after all user modifications have been made, and as rarely as possible. It should be noted that the amount of guaranteed memory write cycles is 10 000 |
| userdb_ver | STRING | Allows readout of card database stored in RAM (if the base is sent to the reader with HTTP Client). If the card database is updated dynamically or dependent on specified conditions, this command allows to monitor its version and to check if changes have been made. |
| enable | 0 | 1 | Enable or disable card reading |
| removeLogsN | INTEGER | Delete last n logs eg.: "removeLogsN":10 will delete 10 oldest logs |
| removeLogs | 1 | Delete all logs |
| releaseId | INTEGER | Release the newId flag (if block RFID read is enabled) |
| cardlog_remove_n | INTEGER | Delete last n card logs eg.: "cardlog_remove_n":4 will delete 4 oldest logs |
| cardlog_remove_all | 1 | Delete all logs |
| rfid_timeout | INTEGER | RFID antenna timeout after specified time |
Example response to overwriting of user database:
{
userdb_ver: 'test',
renewUser: [
{
uid: '12345678',
name1: 'John',
name2: 'Smith',
userId: -1,
flag: 1,
parent: -1
},
{
uid: 'ABCDEF01',
name1: 'Jan',
name2: 'Kowalski',
userId: -1,
flag: 1,
parent: -1
}
]
}
Example of php server support:
<?php
if( $_GET["id"] ) // receive id and MAC - $_GET["mac"]
{
$who=$_GET["id"];
// check id in DB and do some action
echo "<root>";
echo "<buzz>1</buzz>"; // sound signal
echo "<text>Card ID: $who</text>" // message ID on LCD
echo "<open1>1</open1>"; // door open
echo "</root>";
}
else // no id – poll request
{
echo "<text> Place an RFID tag</text>"; //standby text
}
MQTT Client
The device supports the MQTT protocol which allows data exchange in publication / subscription architecture. The settings can be configured in the Services tab under MQTT client.
- Enable – Enable MQTT service,
- Server – IP address or domain of the MQTT broker,
- Port – Port on which port the MQTT server listens (default 1883),
- QoS – Quality of Service, supported by the device:
- QoS 0 – At most once,
- QoS 1 – At least once,
- QoS 2 – Exactly once.
- Publish Topic – Topic to which the device sends data,
- Subscribe Topic – Topic, from which the device receives data,
- Client ID – MQTT client ID,
- User – User name (if authentication is needed),
- Password – User password (if authentication is needed),
The device supports the encrypted MQTT protocol. Available configuration options are similar to those available for HTTP Client configuration.
Publish topic
After the MQTT protocol is configured, triggers causing data to be sent to a defined topic (Publish Topic) should be declared. Similarly to HTTP Client, there are three triggers available:
- On new card action – Send the MQTT message every time an RFID card is applied to the reader,
- Action hold card – Send a MQTT message in a card remains in the read field for at least 5 seconds (default hold time),
- Action remove card – Send a MQTT message if the RFID tag is removed from the read area.
Each of the triggers operates independently, which allows configuring their operation to suit the user's needs. The user can choose what events cause a MQTT message to be sent.
For MQTT payload contents:
uid=%uid%&name1=%usr_name1%&name2=%usr_name2%
Data visible on the server side:
uid=87878A4C&name1=John&name2=Smith
Tip
The data visible on the server side depend on the contents of the sent message. If the Search card in database option (Card Action page in On new card action section) is set to All like unknown, the device will not search the interncal card database. In this case, all user variables will be treated as an unknown card.
Data visible on the server side with Search card in database disabled:
uid=878A8A4C&name1=&name2=
Subscribe topic
The device can be controlled via the MQTT protocol. To make this possible, Subscribe Topic from which the device will receive control commands must be configured. To do that, input the required MQTT broker settings on the Services / MQTT site and define the Subscribe Topic.
Example configuration:
Information
The device sends data to the reader/prod2/sec1 topic,
It receives the messages from reader/prod2/sec1/c
Tip
The device supports all HTTP protocol commands. They should be divided with "&".
Example message sent to reader/prod2/sec1/c:
lcd_text1= Place an RFID tag&buzz=3
The device will display Place an RFID tag in the second LCD line and emit a short (beep). It's possible to use the same topic for publishing and subscribing – this enables instant device control after data is sent to Publish Topic.
The device can send encrypted e-mail messages that can be configured in the Services tab.
- E-mail – Activate the SMTP service,
- Server – SMTP server address,
- Port – SMTP server port, on which messages are received,
- SSL/TLS – Encryption configuration:
- Off – No encryption, connection unencrypted,
- SSL/TLS – SSL/TLS Encryption,
- STARTTLS – Enables the use of STARTTLS during connection.
- User – User name used for authentication in the SMTP server,
- Password,
- From – "From" field visible in the e-mail message header,
- Recipients – List of message recipients, e-mail addresses separated by commas,
- Subject – Subject of the e-mail message and name of the attachment file (eg. logs),
- Debug – Debugging mode enabling diagnostics of SMTP configuration errors.
- Sending logs periodically – Log file extension to be sent as an attachment,
- Erase logs after send – Option to erase the logs after they are successfully sent,
- Time – CRON format log sending schedule:
- Syntax: seconds, minutes, hours, day, month, day of the week.
Configuration testing
After applying the settings, the user can test the configuration using the E-mail test button. The device will attempt to send a test message, that should reach the recipient immediately. If no message is received, check the SPAM folder.
Troubleshooting
If problems with message sending arise, Debug mode can be enabled in order to diagnose the errors:
- Open the debugging page in a new browser tab, typing in:
http://<device IP address>/protect/dmesg.html
or click Open debugger here! on the configuration page, - Push the Send a test e-mail button,
- Details concerning the message sending problems will appear in the debugger's window. Analysis of this information will allow the problem to be identified and solved.
Modbus TCP/RTU
The device supports the Modbus TCP and Modbus RTU protocols. Connection configuration is available on the webpage under the Services / Modbus tab.
- Modbus TCP – Enable the Modbus TCP service,
- TCP port – Modbus TCP protocol port (default 502),
- Modbus RTU – Enable the Modbus RTU service,
- PDU – Device Modbus address,
- RTU Baudrate – Data transfer speed; available values:
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
- RTU Parity – Parity settings:
- None
- Odd
- Even
- RTU Stop bit – Number of stop bits:
- 1
- 2
- Card action – Reaction of the reader for card application:
- Control by modbus – Control of the device by Modbus only,
- Reader card action – Reaction compliant with settings from the Card Action tab.
- Log Card Action – Logging of events during a correct connection with master (only for the Card Action → Reader card action setting):
- As card action (if set) – Logging compliant with Card Action settings,
- Omit log action – Omit the Card Action settings.
- Block RFID read – Block read of a next tag:
- Block – After a tag is read, value 1 is sent to the Holding Register 1. Readout of another transponder is possible after a read flag is reset (value 0 in Holding Register 1),
- Continous – Automatic erasure of the read flag – allows instantaneous reading of other RFID tags.
- Safe mode – Reaction of the reader in the event that Modbus connection is lost:
- Disable,
- No action – No reader reaction for an applied tag,
- Standalone (Reader Card Action) – Transition to autonomous mode.
- Safe Timeout – Time until the reader enters Safe mode.
The device supports the following Modbus functions:
- 0x01 Read Coils
- 0x03 Read Holding Register
- 0x05 Write Single Coil
- 0x06 Write Single Register
- 0x0F Write Multiple Coils
- 0x10 Write Multiple Registers
Holding Registers addresses
| Address | R/W | Description |
|---|---|---|
| 1 | R/W | Read flag Read: 1 – a new transponder has been read Write: 0 – zeroizing of read flag |
| 2 | R | ID_LEN |
| 3 | R | Card ID/UID/CSN [0] |
| 4 | R | Card ID/UID/CSN [1] |
| 5 | R | Card ID/UID/CSN [2] |
| 6 | R | Card ID/UID/CSN [3] |
| 7 | R | Card ID/UID/CSN [4] |
| 8 | R | Card ID/UID/CSN [5] |
| 9 | R | Card ID/UID/CSN [6] |
| 10 | R | Card ID/UID/CSN [7] |
| 11 | R | Card ID/UID/CSN [8] |
| 12 | R | Card ID/UID/CSN [9] |
| 13 | R | Reserve |
| 14 | R | User ID – 65535 indicates an unknown tag |
| 20 | R/W | Output #1 control according to I/O Settings tab |
| 21 | W | Output #1 control in bi-stable mode |
| 22 | W | Output #1 enable for a time set as a parameter (value * 0.1 sec) |
| 23 | W | blink_on time (value * 0.1 sec) |
| 24 | W | blink_off time (value * 0.1 sec) |
| 25 | W | Output #1 control in flashing mode (time set in registers 23/24) |
| 26 | R/W | Output #2 control according to I/O Settings tab |
| 27 | W | Output #2 control in bi-stable mode |
| 28 | W | Output #2 enable for a time set as a parameter (value * 0.1 sec) |
| 29 | W | blink_on time (value * 0.1 sec) |
| 30 | W | blink_off time (value * 0.1 sec) |
| 31 | W | Output #2 control in flashing mode (time set in registers 29/30) |
Logs
| Address | R/W | Description |
|---|---|---|
| 1200 | R/W | Log amount [MSB], sending 0 will delete all logs |
| 1201 | R | Log amount [LSB] |
| 1202 | R | Selected log [MSB] |
| 1203 | R | Selected log [LSB] (log numbering starts from 0) |
| 1204 | W | Delete oldest logs, amount set as a parameter |
| 1205 | R | Timestamp [MSB] |
| 1206 | R | Timestamp [LSB] |
| 1207 | R | Reserve |
| 1208 | R | Log source (main reader, auxiliary reader) |
| 1209 | R | Action |
| 1210 | R | UserID – FFFF indicates an unknown tag |
| 1211 | R | UID – Code saved in ASCII m |
| ...1231 | R | Last register with optional data |
Display
| Address | R/W | Description |
|---|---|---|
| 2000 | R/W | LCD Mode: 0 – autonomous operation -1 – Modbus control Value from 1 to 65534 – text display time in seconds. After the time passes, the display will enter autonomous mode. |
| 2001 | R/W | LCD TIME, if LCD Mode=1: 0 – do not display time on LCD 1 – display time on LCD |
| 2002 | R/W | LCD Clear: 1 – clear LCD |
| 2003 | W | Display backlight: 0 – disable backlight 1 – enable backlight >1 – backlight time (value * 0.1 sec). |
| 2010-2029 | W | LCD first line – UTF-8 encoding (eg. a = 85C4) |
| 2030-2049 | W | LCD second line – UTF-8 encoding |
| 2050-2069 | W | LCD third line – UTF-8 encoding |
| 2070-2089 | W | LCD fourth line – UTF-8 encoding |
Single Coil addresses
| Address | R/W | Description |
|---|---|---|
| 1 | R/W | Output #0 control according to I/O Settings |
| 2 | R/W | Output #1 control according to I/O Settings |
| 3 | R | Output #0 coil state |
| 4 | R | Output #1 coil state |
| 11 | R | Input #0 state |
| 12 | R | Input #1 state |
| 13 | R/W | Red LED control |
| 14 | R/W | Green LED control |
| 15 | W | Sound generator control - ACCEPT sound |
| 16 | W | Sound generator control - REJECT sound |
| 17 | Reserve | |
| 18 | R/W | Reset status Read: 1 – a restart happened (eg. because of power loss) |
Factory settings, backup
Restoring factory settings
To restore the device to factory settings:
- Power up the device.
- Short the RESET jumper for a time between 10 and 15 seconds.
- Remove the RESET jumper when the signal sounds.
Information
Factory settings can be restored by using the built-in www server. The user should go to the Administration tab, then in Backup tab press the Reset to default button, which is located at the bottom of the page.
Once the above steps have been completed, the device will be set to the following parameters:
- IP address: 192.168.111.15
- IP mask: 255.255.255.0
- User: admin
- Password: admin
Backup
All configuration data can be saved to a file. The user can create/upload the backup file on the Administration / Backup page.
Creation of a configuration data save requires a password.
Emergency firmware restore
To restore firmware after a failure:
- Short the RESET jumper.
- Power up the device and connect it to LAN.
Once the above steps have been completed, the device will be set to the following parameters:
- IP address: 192.168.111.15
- IP mask: 255.255.255.0
Tip
In order to access the 192.168.111.15 address, computer's IP address must be in the same subnet (example computer address: 192.168.111.1).
Referring to the specified IP address will give access to the device's bootloader.
In this location it is possible to upload firmware, reset the device to factory settings and reboot.
Warranty and manufacturer's liability
Warning
The manufacturer provides a two-year warranty for the device and post-warranty service for a period of 10 years from the date of introduction of the device to the market. The warranty covers all material and production defects.
The manufacturer undertakes to respect the warranty agreement, if the following conditions are met:
- All repairs, changes, expansions and device calibrations are carried out by the manufacturer or an authorized service center,
- The power supply system meets the applicable standards,
- The device is operated in accordance with the suggestions presented in this manual,
- The device is operated in accordance with its intended purpose.
The manufacturer assumes no responsibility for consequences resulting from improper installation, improper use of the device, failure to comply with the instruction manual, and repairs made by unauthorized personnel.
Warning
The device contains no user serviceable parts inside.
Storage, operation and transport conditions
The device should be stored in enclosed rooms, where the atmosphere is free from vapours and corrosive substances:
- Environment temperature from -30°C to +60°C (-22°F - 140°F),
- Humidity from 25% to 90% (condensation unacceptable),
- Atmospheric pressure from 700 to 1060 hPa.
The device is intended to operate in the following conditions:
- Environment temperature from -10°C do +55°C (14°F - 131°F),
- Humidity from 30% to 75%,
- Atmospheric pressure from 700 to 1060 hPa.
Recommended transport conditions:
- Environment temperature from -40°C do +85°C (-40°F - 185°F),
- Humidity from 5% to 95%,
- Atmospheric pressure from 700 to 1060 hPa.
Installation and device operation:
- The module should be operated in accordance with recommendations provided later in this manual.
Disposal and decommissioning
In an event the device needs to be decommissioned (eg. after its intended life period is surpassed), it is recommended to contact the manufacturer or his representative, who are responsible to respond appropriately, i.e., to collect the device from the user. The user can alternatively contact companies specializing in electronic device or computer equipment disposal and/or decommissioning. Under no condition should the device be placed with other waste.