BoxID

Overview

Purpose of the device

BoxID LCD (with an LCD display) and BoxID LED (with LED indicators) are modern RFID readers, designed for a wide range of applications such as industry, services, trade, and logistics. Thanks to comprehensive functionality, the devices will perform well as a machine log-in devices, access control to rooms (eg. warehouses), part of a customer loyalty system or a work time recorders.

Equipped with built-in memory, BoxID allows storing of saved logs, which allows it to function autonomously without need for an external server. IP65 ingress protected enclosure guarantees device reliability even in difficult external conditions, provided a cable gland is installed properly.

The device supports integration with different systems thanks to Modbus TCP/RTU and HTTP (client/server) protocol support. It has numerous inputs and outputs that allow control over the device's elements such as the display, buzzer or additional inputs/outputs. Power can be supplied from various sources, optionally via PoE (Power over Ethernet), which makes BoxID flexible and easily adaptable to specific user requirements and installation conditions.

Changelog

1.1 24 czerwca 2025

• Firmware revision v0.07
  • Added a BoxID LCD description

1.0 11th of March 2025

• Firmware revision v0.06

Device construction

Technical characteristics

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

Connector description

1. LAN – LAN connection socket,
2. RS485 – RS-485 connector for Modbus RTU communication. Additionally provides the power for external readers, e.g. Inveo Exter,
3. Reset – RESET jumper – Shorting the pins for a time between 10-15 seconds restores the device to factory settings,
4. Battery holder,
5. RelayMode – Relay mode jumpers. In position 1-2 - NO relay output, 2-3 - PWR output – voltage is supplied from the power input (12-24V DC),
6. OUT1 – Relay No. 0 connector,
7. OUT2 – Relay No. 1 connector,
8. IN1 – General purpose input,
9. IN2 – General purpose input,
10. +12V- – 12-24V DC power 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.

• Normally Open mode – Jumpers set in position 1-2 (as shown in the image below). In this mode an external power source is necessary.

M12 connector

BoxID may additionally be fitted with a built-in M12 connector (4 pin; male; D-coded). The M12 connector is an industry standard which offers exceptional resistance from:

• humidity,
• dust,
• vibrations.

Benefits of using the M12 connector:

• Connection reliability: stable data transmission even in harsh operating conditions,
• Speed and fidelity: easy and quick interfacing with other systems,
• Standardization: makes interfacing with existing industrial infrastructure easy,
• Application flexibility: allows a wide range of device adaptation in different enviroments.

Connection diagram

Communication channels and general characteristics

BoxID LCD module general view

BoxID LED module general view

BoxID allows communication both by LAN (WLAN) and RS-485 interface, offering a wide array of communication protocols which allow for remote status monitoring and device management:

• Built-in WWW server, accessible via a standard web browser,
• HTTP/HTTPS in server mode,
• HTTP/HTTPS in client mode,
• Modbus TCP,
• Modbus RTU (via RS-485 or optionally RS-232),
• MQTT/MQTTS in client mode.
• E-mail

Device versions

There are two BoxID versions available:

• Model with an LCD screen,
• Model with LED indicators.

Both models signal the power supply and card read conditions and the user has the ability to manage additional functions such as:

• sound alert,
• LCD screen,
• LED indicators.

Network configuration

Changing basic network parameters – Discoverer programme

1. Download and install the Discoverer programme.

2. After installing and starting the application:

   • Select the appropriate network interface from the list of available options. (It's best to use Broadcast),
   • Click Discover Devices to browse for all Inveo devices available on the network.

3. After the device list is displayed, right-click on the selected device and open the network configuration window.

Changing the computer subnet address for configuration

During configuration without Discoverer programme, it's needed to change the subnet address of the computer on the same network.

In order to access the computers 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:
1. Select the network connection.
2. Right-click it and select Properties.
3. After selecting this option, network connection configuration screen will appear.

Select Internet protocol version 4 (TCP/IPv4) and type in the following parameters:

Configuring LAN and Wi-Fi

In the Administration / Network tab, it's possible to change the LAN (and WLAN - if available) parameters.

If DHCP is selected, the module will attempt to retrieve the IP address, subnet mask, network gateway, and DNS addresses from the DHCP server. In this case, IP Address, IP Mask, Gateway, DNS1, DNS2 fields remain inactive.

If the DHCP server is not available, the device will set its own parameter values in the grayed-out fields.

The following fields are used for network configuration:

• DHCP – Enable/disable automatic retrieval of the IP address,
• IP Address – Module IP address (set manually if DHCP is absent),
• IP Mask – IP subnet mask,
• Gateway – Network gateway,
• DNS1, DNS2 – DNS addresses,
• SSID – Wireless network broadcast name,
• Password – Wireless network password,
• Encryption – Encryption type.

Checking the network 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

The device's home page accessible via a web browser is the device's main user interface that allows 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.

In the upper portion of the website an information ribbon is located, informing the user about key device data, such as: model, IP address, unique user-assigned name, firmware version, and MAC address.

Device status

Detailed information are displayed on the home screen:

• Input and output status,
• Operational parameters of the device.

Status table:

• Input #0 – Displays the current state of the first binary input,
• Input #1 – Displays the current state of the second binary input,
• Output #0 – Informs about the current state of the relay output No. 0,
• Output #1 – Informs about the current state of the relay output No. 1,
• Last read UID – Displays the ID of last read RFID tag in hexadecimal format (HEX),
• Number of read UIDs – Displays the number of RFID tags read since last device restart,
• Last card action,
• Uptime – Time since last device restart.

Administration

The Administration tab in device's user interface enables management of key system settings. The Administration tab is divided into a few sub-tabs, each of which offers dedicated functions, simplifying navigation and allowing quick access to various options. The user can adjust the device to their own needs simply and intuitively.

Changing the device's name and access password

In the Access section located in the Administration tab, the user can:

• Assign a unique name to the device, which makes identifying and managing multiple devices in the network easy,
• Use the Enable Remote Config option, which allows for remote device configuration.

The user also has the option to change the device access password. To do that:

1. In the Current Password field, input the current password,
2. In the New Password and Re-type Password, input the new password,
3. Click Save to save the changes.

Time settings

In the Administration / Time section, date and time settings are located. The device is equipped with a Real Time Clock with a battery backup, which allows for correct time measurement even during a power loss.

In the SNTP configuration table, a time server for downloading current time can be specified:

• Enable – Enable SNTP client,
• Server – IP address or domain name of the SNTP server,
• Poll time – Time server querying frequency.

The Daylight saving option allows for automatic switching between daylight savings time. Time zone allows selection of a time zone.

The Update Time button synchronizes the device's internal clock with the current PC time.

Diagnostics, events

The module offers advanced diagnostic options, allowing for data logging and sending them to a Syslog server. The settings are located in the Administration / System Events tab.

The Log Events to flash settings table allows the user to configure events, that are to be logged to flash memory:

• Flash logs enable – Enable logging events to flash memory,
• Cards event logs – Log card events - independent of card memory,
• IO logs – 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.

Adding licenses

The License update field in the Update tab is used to add new or update the current licenses.

I/O Settings

The I/O Settings tab enables configuration of input and output related settings. The reader is equipped with two relay outputs and two potential-free digital inputs. The user has can adjust relay operations and input configuration in accordance to application needs.

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 0,1 second units, during which the relay will remain active,
• Out Time Long – Time of relay activation for the On long period mode. The user can input a value in 0,1 second units, during which the relay will remain active,
• Out Invert – Software change of relay state - default NO (Normally Open); selecting this option changes it to NC (Normally Closed).

Digital input settings:

• Input invert – Software change of default input state,
• Input – Defines the action that will be undertaken when the input is activated:
  • None – No action,
  • Trigger output #0 – Trigger the relay output No. 0,
  • Trigger output #1 – Trigger the relay output No. 1.
• Input invert – Software inversion of the default input state,
• Input filter – Allows to define a time (in ms) during which the device ignores short changes to input signal, treating them as interference. The value of 0 disables filtration, introducing no delays.

LCD screen

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,
• Clock – Option to display a clock in the first line of the display,
• LCD Text – Standby state display text, the user can use the available list of variables by clicking Show help.

Predefined variables

The user has access to a set of predefined variables that can be used to configure display text and other functions:

RFID Settings

The tab allows the user to select an RFID standard and configure tag read, NFC and external reader parameters.

Setup – RFID standard selection

• RFID standard. For the HF version, the following options are available:
  • Mifare
  • ICODE
  • iClass – CSN only
• Card log – Global control over card events logging,
• Swap UID – Swap UID bytes,
• Action Hold time – Amount of time (in seconds) a card needs to be present in the read field to trigger the Action hold card,
• Remove card timeout – Amount of time (in 0,1s units) of card absence to trigger the Action remove card

Card data – Only for HF version when Mifare is selected

• Card data – Enable/disable Mifare card data reading/writing function,
• Block – Read block address,
• Auth key A/B – Authentication key selection (default A),
• 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),
• Allow UID without card data – Overwrite card data without reading it previously (always enabled with NFC),
• Override UID – Override card ID with read data,
• Override UID offset – Character that the data readout begins from.
• Override UID len – Length of the data string to be read.

NFC – Only for HF version when Mifare is selected

The reader has the option to assign a smartphone with the Inveo NFC iTag application installed as an RFID tag, allowing the user to e.g. access the room without the need to phisically posess additional keycards or RFID tags.

• Enable NFC – Enable the smarphone-emulated card reading function,
• Read mode – Data reading mode selection:
  • HEX
  • Plain text

Configuration of an external reader

In the External reader configuration tab, you can configure support of an external RFID reader and define how the device is supposed to react for events from that reader.

RFID external – Allows selection of a supported external RFID reader type. After selecting one of those options, the device may restart to enable/disable operation of the new reader.

• Disabled

Disables the operation of an external RFID reader (default).

• Promag

• Inveo IND

• Inveo Exter

The green wire is used to enter the Bootloader mode. It should be insulated and left unused.

Log flag

This option allows to add an additional flag to a logged event if a card is read by an external reader. Available values:

• No change: No additional flag – log remains unchanged compared to standard entries,
• Enter Work: Adds information about the fact, that the event concerns "work mode" (eg. shift begins or entrance to a work zone),
• Exit Work: Means that "work mode" has been ended (eg. shift ends, exit from a work zone),
• Enter Priv: Informs about the fact that the user leaves a workplace for private reasons (eg. visiting a doctor) – this time does not count towards work time,
• Exit Priv: Informs about the fact that the user ends his private time and returns to work – time spent in private does not count towards work time.

Log

• On/Off – Enables or disables logging of events from an outside RFID reader.

IO

• On/Off – If enabled, the device will react to events from the external reader the same way it reacts to events from its built-in reader - eg. with LED indicators, buzzer or LCD display.

Request

• On/Off – If enabled, the device will send requests to the server with each card read event from the external reader, just like for cards read with its built-in reader. This allows for integration with remote systems (eg. access control, work time recording) in the same way as with the built-in RFID reader.

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.

On-new

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.

• HTTP Request – Enable the On-new card service,
  • HTTP Method – HTTP communication method: GET, POST, PUT, DELETE,
  • Content type – Header specifying the type of transferred data (eg. application/json, application/x-www-form-urlencoded),
  • HTTP request – HTTP request syntax field.
• MQTT – Enable the MQTT service,
  • Publish Topic – Topic, to which the card read action notification will be sent to,
  • MQTT payload – MQTT notification syntax.
• Wait for server response – If the option is enabled, the reader waits for server reply and executes returned commands (controlling the LED, LCD, buzzer, I/O). Otherwise, it checks the card database and executes appropriate actions,
• Connection fail action – Set execution of action known/unknown in the event of server communication loss,
• Action by HTTP status code – Set execution of action known/unknown depending on the server HTTP response code,
• LCD Text – Text that will be displayed on the LCD screen while the reader awaits a reply from the server,
• Sound – Sound signal:
  • None – None,
  • Accept – Tag accepted signal,
  • Reject – Tag rejected signal,
  • Tick – Short sound signal.
• Output #0 – Activation of relay output No. 0:
  • None – Skip,
  • Off – Disable relay output,
  • On – Enable relay output,
  • Toggle – Change of relay state to the opposite,
  • Period – Enable the relay output for Out #0 Time time period defined in the I/O Settings tab,
  • Long Period – Enable the relay output for Out #0 Time Long time period defined in the I/O Settings tab,
  • User Period – Enable the relay output for Output #0 User period.
• Output #1 – Activation of relay output No. 1 – Settings similar to output #0,
• LCD backlight – Display backlight:
  • None – Skip,
  • Off – Disable display backlight,
  • On – Enable display backlight,
  • Toggle – Change backlight state to the opposite,
  • Period – Enable the backlight for Out Time time period defined in the I/O Settings tab,
  • Long Period – Enable the backlight for Out Time Long time period defined in the I/O Settings tab,
  • Blink – Timed backlight blinking.
• LCD Text Timeout – Time of displaying text on the display:
  • 0 – Do not display text,
  • -1 – Display text continously, until a new announcement appears,
  • different value – Time of announcement display in seconds.

On-known

This tab allows defining reactions of the reader after a card stored in the device's memory is applied.

• Log event – Enables logging of card application events if action attributed to the card is known and has been defined in the system.
• LCD text – Message displayed on the screen the moment an RFID card is recognized,
• Sound – Sound signal:
  • None – None,
  • Accept – Tag accepted signal,
  • Reject – Tag rejected signal,
  • Tick – Short sound signal.
• Output #0 – Activation of relay output No. 0:
  • None – Skip,
  • Off – Disable relay output,
  • On – Enable relay output,
  • Toggle – Change of relay state to the opposite,
  • Period – Enable the relay output for Out #0 Time time period defined in the I/O Settings tab,
  • Long Period – Enable the relay output for Out #0 Time Long time period defined in the I/O Settings tab,
  • User Period – Enable the relay output for Output #0 User period.
• Output #1 – Activation of relay output No. 1 – Settings similar to output #0,
• LCD backlight – Display backlight:
  • None – Skip,
  • Off – Disable display backlight,
  • On – Enable display backlight,
  • Toggle – Change backlight state to the opposite,
  • Period – Enable the backlight for Out Time time period defined in the I/O Settings tab,
  • Long Period – Enable the backlight for Out Time Long time period defined in the I/O Settings tab,
  • Blink – Timed backlight blinking.
• LCD Text Timeout – Time of displaying text on the display:
  • 0 – Do not display text,
  • -1 – Display text continously, until a new announcement appears,
  • different value – Time of announcement display in seconds.
• LED period – Green LED glow time (BoxID LED).

On-unknown

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.

• Log event – Enables logging if an RFID tag is not recognized.
• LCD text – Message displayed on the screen the moment an RFID card is not recognized,
• Sound – Sound signal:
  • None – None,
  • Accept – Tag accepted signal,
  • Reject – Tag rejected signal,
  • Tick – Short sound signal.
• Output #0 – Activation of relay output No. 0:
  • None – Skip,
  • Off – Disable relay output,
  • On – Enable relay output,
  • Toggle – Change of relay state to the opposite,
  • Period – Enable the relay output for Out #0 Time time period defined in the I/O Settings tab,
  • Long Period – Enable the relay output for Out #0 Time Long time period defined in the I/O Settings tab,
  • User Period – Enable the relay output for Output #0 User period.
• Output #1 – Activation of relay output No. 1 – Settings similar to output #0,
• LCD backlight – Display backlight:
  • None – Skip,
  • Off – Disable display backlight,
  • On – Enable display backlight,
  • Toggle – Change backlight state to the opposite,
  • Period – Enable the backlight for Out Time time period defined in the I/O Settings tab,
  • Long Period – Enable the backlight for Out Time Long time period defined in the I/O Settings tab,
  • Blink – Timed backlight blinking.
• LCD Text Timeout – Time of displaying text on the display:
  • 0 – Do not display text,
  • -1 – Display text continously, until a new announcement appears,
  • different value – Time of announcement display in seconds.
• LED period – Red LED glow time (BoxID LED).

On-hold

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 RFID Settings section.

• Log event – Enables event logging if an RFID tag is held in range of the reader,
• LCD text – Message displayed on the screen if an RFID tag is held in range of the reader for time defined in the Action Hold time field,
• Sound – Sound signal:
  • None – None,
  • Accept – Tag accepted signal,
  • Reject – Tag rejected signal,
  • Tick – Short sound signal.
• Output #0 – Activation of relay output No. 0:
  • None – Skip,
  • Off – Disable relay output,
  • On – Enable relay output,
  • Toggle – Change of relay state to the opposite,
  • Period – Enable the relay output for Out #0 Time time period defined in the I/O Settings tab,
  • Long Period – Enable the relay output for Out #0 Time Long time period defined in the I/O Settings tab,
  • User Period – Enable the relay output for Output #0 User period.
• Output #1 – Activation of relay output No. 1 – Settings similar to output #0,
• LCD backlight – Display backlight:
  • None – Skip,
  • Off – Disable display backlight,
  • On – Enable display backlight,
  • Toggle – Change backlight state to the opposite,
  • Period – Enable the backlight for Out Time time period defined in the I/O Settings tab,
  • Long Period – Enable the backlight for Out Time Long time period defined in the I/O Settings tab,
  • Blink – Timed backlight blinking.
• LCD Text Timeout – Time of displaying text on the display:
  • 0 – Do not display text,
  • -1 – Display text continously, until a new announcement appears,
  • different value – Time of announcement display in seconds.
• HTTP Request – Enable the HTTP service,
  • HTTP Method – HTTP communication method: GET, POST, PUT, DELETE,
  • Content type – Header specifying the type of transferred data (eg. application/json, application/x-www-form-urlencoded),
  • HTTP request – HTTP request syntax field.
• MQTT – Enable the MQTT service,
  • Publish Topic – Topic, to which the card read action notification will be sent to,
  • MQTT payload – MQTT notification syntax.

On-remove

This tab allows defining reactions of the reader the moment a card is removed from the read area.

• Log event – Enables event logging if an RFID tag is removed from the reader,
• LCD text – Message displayed on the screen if an RFID tag is held in range of the reader for time defined in the Action Hold time,
• Sound – Sound signal:
  • None – None,
  • Accept – Tag accepted signal,
  • Reject – Tag rejected signal,
  • Tick – Short sound signal.
• Output #0 – Activation of relay output No. 0:
  • None – Skip,
  • Off – Disable relay output,
  • On – Enable relay output,
  • Toggle – Change of relay state to the opposite,
  • Period – Enable the relay output for Out #0 Time time period defined in the I/O Settings tab,
  • Long Period – Enable the relay output for Out #0 Time Long time period defined in the I/O Settings tab,
  • User Period – Enable the relay output for Output #0 User period.
• Output #1 – Activation of relay output No. 1 – Settings similar to output #0,
• LCD backlight – Display backlight:
  • None – Skip,
  • Off – Disable display backlight,
  • On – Enable display backlight,
  • Toggle – Change backlight state to the opposite,
  • Period – Enable the backlight for Out Time time period defined in the I/O Settings tab,
  • Long Period – Enable the backlight for Out Time Long time period defined in the I/O Settings tab,
  • Blink – Timed backlight blinking.
• LCD Text Timeout – Time of displaying text on the display:
  • 0 – Do not display text,
  • -1 – Display text continously, until a new announcement appears,
  • different value – Time of announcement display in seconds.
• HTTP Client method, HTTP Content type, HTTP Client request – HTTP request settings,
• MQTT – MQTT notifications settings.

Managing cards and events

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.

The Card Database tab in the user interface allows for manual adding, editing and erasing RFID tags from the device's memory.

To add a new user, click + and fill out the Card service table.

• Enable card – Activation of the RFID tag in the device's memory. Disabling this option will skip the tag record during a search operation,
• Name #1 – User's first name,
• Name #2 – User's last name,
• Card UID – RFID tag UID number,
• Get last read UID – Function inputting last read RFID tag,
• Save – Add record to a temporary RFID tag list.

The system allows assignment of multiple RFID cards to a single user. Thanks to that, the user can use multiple cards instead of a single one.

To add additional cards:

1. Go to the user list and find the user you want to assign new cards to,
2. Click the + icon by the main card (parent),
3. Input the new card data and accept.

End result:

RFID tags database from a CSV file

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

RFID tags file (cards.csv):

The first row contains a header (ignored during file upload):

• uid – RFID tag ID,
• name1 – Name1 field from the card database,
• name2 – Name2 field from the card database,
• idx – Order index,
• parent – ID of main card (parent) or -1 if the card is the main one (isn't associated with another card as a sub-card),
• flag – Value of active field from the card database.

Internal RFID card database after uploading the above CSV file (cards.csv):

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:

• data/card.json – to download the card file in JSON format,
• data/card.xml – to download the card file in XML format.

{"card":[
{"uid":"23456678",
"name1":"Julia",
"name2":"Smith",
"idx":"1",
"parent":"-1",
"flag":"1"}
,
{"uid":"12345678",
"name1":"Jack",
"name2":"Smith",
"idx":"2",
"parent":"-1",
"flag":"0"}
,
{"uid":"23456678",
"name1":"Andrew",
"name2":"Smith",
"idx":"3",
"parent":"-1",
"flag":"1"}
,
{"uid":"22345678",
"name1":"Saul",
"name2":"Smith",
"idx":"4",
"parent":"-1",
"flag":"0"}
]}

<card>
    <entry>
    <uid>23456678</uid>
    <name1>Julia</name1>
    <name2>Smith</name2>
    <idx>1</idx>
    <parent>-1</parent>
    <flag>1</flag>
    </entry>
    <entry>
    <uid>12345678</uid>
    <name1>Jack</name1>
    <name2>Smith</name2>
    <idx>2</idx>
    <parent>-1</parent>
    <flag>0</flag>
    </entry>
    <entry>
    <uid>23456678</uid>
    <name1>Andrew</name1>
    <name2>Smith</name2>
    <idx>3</idx>
    <parent>-1</parent>
    <flag>1</flag>
    </entry>
    <entry>
    <uid>22345678</uid>
    <name1>Saul</name1>
    <name2>Smith</name2>
    <idx>4</idx>
    <parent>-1</parent>
    <flag>0</flag>
    </entry>
</card>

• uid – RFID tag ID,
• name1 – Name1 field from the card database,
• name2 – Name2 field from the card database,
• idx – Unique user ID,
• flag – Value of the "active" field from the card database.

Event logging

The device can register events related to application, holding or removal the card from the reader read area. Event log is available:

• On the website,
• In CSV format,
• In XML format,
• In JSON format.

Types of logged events:

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

Events preview using the webpage – Card Logs tab

The Mode value is a sum of the values assigned to the current input / output state:

Viewing event logs with a CSV, XML lub JSON file

CSV log file structure – access via the http://device_ip/data/log.csv resource

timestamp;time;date;action;user_id;uid;name1;name2;enter
1742904651;12:10:51;25.03.2025;2;2;D57E2014;Jan;Kowalski;1024
1742904652;12:10:52;25.03.2025;2;1;31C19E1B;Jane;Smith;1024
1742904654;12:10:54;25.03.2025;2;0;61F3911B;John;Smith;1024

<logs>
    <entry>
        <action>2</action>
        <timestamp>1742904651</timestamp>
        <time>12:10:51</time>
        <date>2025-03-25</date>
        <userId>2</userId>
        <uid>D57E2014</uid>
        <name1>Jan</name1>
        <name2>Kowalski</name2>
        <mode>1024</mode>
    </entry>
    <entry>
        <action>2</action>
        <timestamp>1742904652</timestamp>
        <time>12:10:52</time>
        <date>2025-03-25</date>
        <userId>1</userId>
        <uid>31C19E1B</uid>
        <name1>Jane</name1>
        <name2>Smith</name2>
        <mode>1024</mode>
    </entry>
    <entry>
        <action>2</action>
        <timestamp>1742904654</timestamp>
        <time>12:10:54</time>
        <date>2025-03-25</date>
        <userId>0</userId>
        <uid>61F3911B</uid>
        <name1>John</name1>
        <name2>Smith</name2>
        <mode>1024</mode>
    </entry>
</logs>

{
"logs": [
    {
    "action": 2,
    "mode": 1024,
    "ts": 1742904651,
    "time": "12:10:51",
    "date": "2025-03-25",
    "userId": 2,
    "uid": "D57E2014",
    "name1": "Jan",
    "name2": "Kowalski"
    },
    {
    "action": 2,
    "mode": 1024,
    "ts": 1742904652,
    "time": "12:10:52",
    "date": "2025-03-25",
    "userId": 1,
    "uid": "31C19E1B",
    "name1": "Jane",
    "name2": "Smith"
    },
    {
    "action": 2,
    "mode": 1024,
    "ts": 1742904654,
    "time": "12:10:54",
    "date": "2025-03-25",
    "userId": 0,
    "uid": "61F3911B",
    "name1": "John",
    "name2": "Smith"
    }
]
}

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 port – HTTP server and device webpage access port,
• HTTPS port – HTTP server and device webpage access port (SSL/TLS encryption required),
• 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:

<status>
    <model>BoxID LCD HF</model>
    <name/>
    <mac>00:00:00:00:00:00</mac>
    <id/>
    <newId>0</newId>
    <rfid_enable>1</rfid_enable>
    <cnt>0</cnt>
    <n_logs>3</n_logs>
    <in0>0</in0>
    <in1>0</in1>
    <cnt0>0</cnt0>
    <cnt1>0</cnt1>
    <out0>0</out0>
    <out1>0</out1>
    <custom>0</custom>
    <fw>0.07</fw>
    <userdb_dirty>0</userdb_dirty>
    <time>06:19:38</time>
    <date>27-06-2025</date>
</status>

{
"model": "BoxID LCD HF",
"name": "",
"mac": "00:00:00:00:00:00",
"id": "",
"newId": 0,
"rfid_enable": 1,
"cnt": 0,
"n_logs": 3,
"in0": 0,
"in1": 0,
"cnt0": 0,
"cnt1": 0,
"out0": 0,
"out1": 0,
"custom": 0,
"fw": "0.07",
"userdb_dirty": 0,
"time": "06:19:38",
"date": "27-06-2025"
}

HTTP GET – Control

All IO commands start with /io?

HTTP GET – RFID card database

All DB commands start with /db?

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 transfer: After an RFID tag is read, the module automatically connects to the server and transfers information about the tag,
• Receiving commands from the server: The server can send module control instructions such as: activate LED's, generate sounds, display text on the LCD screen,
• Easy integration: The mode allows for 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 – 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 request interval – Server query frequency (0 - off),
• HTTP ping request – Server query request syntax.

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

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=T&in1=1 HTTP/1.1
User-Agent: BoxID
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: BoxID
Host: 192.168.0.90
Content-Type: application/x-www-form-urlencoded
Content-Length: 33
ip=192.168.0.176
name=T
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.

The user configures the request content, its type and a method for each trigger separately.

HTTP request configuration parameters:

• HTTP Request – Enable HTTP Request service,
• 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).

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: BoxID
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"
}

HTTP Client – Control

{
userdb_ver: 'test',
renewUser: [
    {
    uid: '12345678',
    name1: 'John',
    name2: 'Smith',
    idx: -1,
    flag: 1,
    parent: -1
    },
    {
    uid: 'ABCDEF01',
    name1: 'Jan',
    name2: 'Kowalski',
    idx: -1,
    flag: 1,
    parent: -1
    }
]
}

<?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 for data exchange in publication/subscription architecture. The settings can be configured in the Services tab, under MQTT client.

• MQTT Client – Enable MQTT service,
• Broker – 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.
• 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),
• Publish Topic – Topic to which the device sends data,
• MQTT ping payload interval – Interval between consecutive ping requests,
• MQTT ping payload – Ping request syntax,
• Send test message – A message with a payload of "1" will be sent to "validation" topic.

The MQTT Last Will and Testament (LWT) section is used to configure the mechanism for notifying MQTT brokers of unexpected device disconnection.

• LWT – Enables or disables Last Will and Testament. If the option is active, the MQTT broker will receive the preprogrammed message in the event of a connection loss by the device,
• QoS (Quality of Service) – Defines the level of service quality for the LWT message:
  • QoS 0 – The message is sent once, with no confirmation of delivery,
  • QoS 1 – The message is sent repeatedly until the broker confirms reception,
  • QoS 2 – The message is sent and confirmed in a way that ensures a single delivery.
• LWT retain – If enabled, the LWT message will be saved on the broker an will be available for new topic subscribers,
• LWT Topic – Defines MQTT topic, to which the LWT message will be published,
• Example: /device/MAC_address/lwt.
• LWT Message – Content of the message the broker will publish when the device unexpectedly looses connection,
• For example it may be offline or any other announcement specifying device status.

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 – Send the MQTT message every time an RFID card is applied to the reader,
• On-hold – Send a MQTT message if a card remains in the read field for at least 5 seconds (default hold time),
• On-remove – 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 publish topic content:

uid=%uid%&name1=%usr_name1%&name2=%usr_name2%

Data visible on the server side:

uid=87878A4C&name1=John&name2=Smith

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:

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.

• SSL/TLS – Enable connection encryption using SSL/TLS protocols,
• SSL certificate mode – Certificate support mode:
  • Use Certificate Bundle – Use the built-in certificate set,
  • Use Uploaded Certificate – Use the uploaded certificate set,
  • Disable SSL verification.
• Skip cert CN check – Skip verification of the Common Name (CN) field in the certificate. Useful in test or non-standard environments,
• Use Client certificate – Enable using a client certificate for authentication on the server side,
• Client key password – Client key password (if required).

• LWT – Enable the Last Will and Testament function, allowing the device to inform the MQTT broker about its condition in the event connection is lost,
• QoS – LWT message Quality of Service level:
  • QoS 0 – At most once, no delivery guarantee,
  • QoS 1 – At least once, the message may be delivered multiple times,
  • QoS 2 – Exactly once, the safest level but the most resource cousuming.
• LWT retain – Set the retain option for LWT messages (retaining last state for new subscribers),
• LWT Topic – Topic to which the LWT message will be sent. Example: /device/MAC_address/lwt,
• LWT Message – Content of the message sent as LWT. Example: Device offline.

• SSL server root certificate – Option to upload a root server certificate in order to verify encrypted connections,
• Client certificate – Option to upload a client certificate used for authenticating the device by the MQTT broker,
• Client key – Option to upload a private key for the client certificate.

E-mail

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,
• Authorization type selection: none or password,
• From – "From" field visible in the e-mail message header,
• Subject – Subject of the e-mail message and name of the attachment file (eg. logs),
• Recipients – List of message recipients, e-mail addresses separated by commas,
• Sending logs periodically – Log file extension to be sent as an attachment:
  • Disable – Log sending disabled,
  • CSV,
  • XML,
  • JSON,
  • Text.
• 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.

• Debug – Debugging mode allowing for diagnostics of SMTP configuration errors.

Configuration testing

After applying the settings, the user can test the configuration using the Send a test e-mail 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:

1. 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,
2. Push the Send a test e-mail button,
3. 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 Modbus TCP service,
  • TCP port – Modbus TCP protocol port (default 502),
• Modbus RTU – Enable 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

Logs

Display

Single Coil addresses

Syslog

The device can 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 Services/Syslog tab.

• Syslog – Enable syslog client,
• Server – Syslog server address,
• Port – Port number, the server is listening on – default 514,
• System events – Send system events to the syslog server,
• System IO – Send input/output events to the syslog server.

Integration with Programmable Logic Controllers

By purchasing an appropriate license, in the Services / PLC tab, it is possible to integrate BoxID and Clocker readers with Siemens and Mitsubishi controllers.

The procedure has been described in several articles on our blog.

Lua Scripts

This tab allows the user to define custom actions and RFID card control logic using the Lua script language.

Interface description

The main tab section contains a code editor that can be used to create and edit Lua scripts. Those scripts allow customization of device operation depending on different RFID card events.

Control buttons

• Reload workspace – Reload the editor,
• Load to module – Upload the Lua script to the device (without saving to persistent memory),
• Store in FLASH – Save the Lua script to device memory (the script will remain active after a restart),
• Clear console – Clear the output console,
• Restore code – Restore the default Lua code.

Available system functions

Lua functions can be used to make the device react to different events.

System functions

• start() – Recalled after the system start-up,
• timeout() – Recalled after set_timeout(ms) has passed,
• void set_timeout(ms) – Sets the internal timer and recalls the timeout() function,
• void clear_timeout() – Clears and disables the timer.

RFID functions

• void rfid_detect() – Recalled when the system detects an RFID card and reads its UID,
• void action_oncard() – The first function activated after a card is detected (before checking the database),
• void action_known() – Recalled when the card is recognized as known,
• void action_unknown() – Recalled when a card is not present in the database,
• void action_hold() – Recalled when a card remains in the read area for a longer time,
• void action_remove() – Recalled when a card is removed from the read area.

Lua libraries

The system offers several libraries enabling interaction with the device. The card, mf, rfid, and dev libraries are specific to Inveo devices. All other libraries are standard.

card library

• getFlag() – Downloads flags associated with the current RFID card,
• getUserId() – Downloads the user ID associated with the current RFID card.

mf (Mifare Classic) library

• auth_ee(key_no, block, ab) – Authorization of the Mifare Classic block if using a key from a secure memory,
• auth_key(key, block, ab) – Authorization of the Mifare Classic block using a provided key,
• rd(block) – Reading of the Mifare Classic block,
• wr(block, data) – Writing of the Mifare Classic block (16 byte),
• deauth() – De-authorization.

rfid library

• getUidBin() – Downloads UID as binary data,
• getUidBinLen() – Downloads the UID length as binary data,
• getUidAscii() – Downloads the UID as ASCII (HEX) text,
• getUidAsciiLen() – Downloads the UID length as ASCII,
• overwriteUidAscii(uid) – Overwrites the UID used by the system,
• pause(time) – Pauses processing of RFID for a given time (ms).

dev library

• out_on(channel) – Enables the output on a given channel,
• out_off(channel) – Disables the output on a given channel,
• out_single(channel, ton) – Sets a single pulse on the output,
• out_blink(channel, ton, toff, cnt) – Sets flash on the output,
• out_get(channel) – Returns the output state,
• in_get(channel) – Returns the input state,
• in_get_cnt(channel) – Returns the input counter,
• buzz(sound) – Buzzer control (0 - accept, 1 - reject, 2 - pulse),
• lcd_clear() – Clears the LCD screen.
• var_txt_set(idx, txt) – Sets text txt for the idx dynamic variable,
• var_txt_get(idx) – Recalls the idx dynamic variable.

table library

• insert(t, [pos], value) – Inserts value to array t. If pos is specified, inserts the element to a specified position, shifting other elements,
• remove(t, [pos]) – Removes the element from pos in t array. If pos is not specified, removes the last added element,
• sort(t, [, comp]) – Sorts the t array in ascending order. Optionally, the comp(a, b) comparison function can be added; it should return true if a should be before b,
• concat(t [, sep [, i [, j]]]) – Combines the t array contents into a single string, separating them with sep from index i to j,
• pack(...) – Returns an array containing all function arguments. Remembers the amount of arguments as n,
• unpack(t [, i[, j]]) – Returns the contents of t array as separate values for indexes i to j. Default: i = 1, j = #t.

string library

• bytebyte(s [, i [, j]]) – Returns the byte code for s characters, from i to j,
• char(...) – Creates a string from the specified values,
• len(s) – Returns the character string length,
• lower(s) – Returns s with upper-case letters converted to lower-case,
• upper(s) – Returns s with lower-case letters converted do upper-case,
• sub(s, i [, j]) – Returns the s substring from i to j,
• rep(s, n) – Returns s repeated n times,
• reverse(s) – Returns the inverted text of s,
• find(s, pattern [, i [, plain]]) – Searches for pattern in s, returns the indexes or nil. Setting plain to true searches with no patterns,
• match(s, pattern [, i]) – Returns the first pattern match,
• gsub(s, pattern, repl [, n]) – Substitutes pattern with the repl string a maximum of n times. Returns the new string and the amount of substitutions.

os library

• time([table]) – Returns current time in UNIX format or converts table to seconds,
• date([format [, time]]) – Returns the date/time in the form of formatted text or a table,
• clock() – Returns the time spent for program exacution by the processor,
• difftime(t1, t2) – Returs the difference in seconds between t1 and t2,

math library

• abs(x) – Absolute value of x,
• ceil(x) – Round up to the nearest whole number,
• floor(x) – Round down,
• fmod(x, y) – Remainder of the x by y division operation,
• max(x, ...) – The biggest number specified,
• min(x, ...) – The smallest number specified,
• sqrt(x) – Square root of x,
• exp(x) – e to the power of x,
• log(x [, base]) – Natural logarithm ln(x) or log_b(x) (if base is specified),
• pow(x, y) – Exponentiation of x^y,
• modf(x) – Splits x into integer and fractional parts int, frac,
• random([m [, n]]) – Random number between 0 and 1,
• randomseed(seed) – Sets a seed of the random number generatos,
• deg(x) – Converts radians to degrees,
• rad(x) – Converts degrees to radiants,
• sin(x) – Sinus (x in radians),
• cos(x) – Cosinus (x in radians),
• tan(x) – Tangens (x in radians),
• asin(x) – Arcus sinus,
• acos(x) – Arcus cosinus,
• atan(x) – Arcus tangens,
• atan2(y, x) – Arcus tangens y/x including the quadrant.

utf8 library

• len(s [, i [, j]]) – Returns the number of UTF-8 characters in the substring s from i to j,
• offset(s, n [, i]) – Returns the byte index in s of the beggining of the nth character (if n positive) or the nth from the end (if n negative),
• codepoint(s [, i [, j]]) – Returns at least one Unicode point code of characters from s between i and j,
• char(...) – Creates an UTF-8 string from the given Unicode point codes,
• codes(s) – Returns the iterator, that returns subsequent byte indexes and Unicode point codes in s,
• charpattern – Lua pattern for matching a single UTF-8 character.

pack library

• pack – Packs data to a binary string,
• unpack – Unpacks data from a binary string,
• packsize – Returns the size of a packet.

Communication

E-mail

• email(recipient, subject, text) – Sends an e-mail,
  • recipient – Recipient address,
  • subject – Message topic,
  • text – Message content.

HTTP

• http_send(url, data, data_length, method, content_type) – Sends a HTTP request,
  • method:
    • 0 - GET,
    • 1 - POST,
    • 2 - PUT,
    • 3 - DELETE.
  • content_type:
    • 0 - PLAIN,
    • 1 - JSON,
    • 2 - XML.

MQTT

• mqtt(topic, data, length) – Publishes a MQTT message.

Logging and debugging

• log(message) – Saves message to flash memory,
• console(message) – Dispays the message in the Lua console.

HTTP Server – Request handling

• httpdscript(name, args) – Function recalled when a HTTP requestr begins with /data/script/,
• httpd_resp(text) – Sets the HTTP response.

Example

function httpdscript(name, arg)
    dev.console("name:"..name.." arg:"..arg)

    local v1,v2,v3 = arg:match("v1=(%d+)&v2=(%d+)&v3=(%d+)")
    dev.console("parsed arg:"..v1.." "..v2.." "..v3)

    if name == "test.json" then
        dev.httpd_resp('{"result":"OK"}')
    elseif name == "test.xml" then
        dev.httpd_resp('<AastraIPPhoneStatus Beep="yes"><Session/><Message type="alert" Color="darkgreen" Timeout="3">Door open</Message></AastraIPPhoneStatus>')
    else
        dev.httpd_resp("")
    end     
end

Application examples

Example 1: Room access control

Objective: Opening doors with authorized RFID cards.

Configuration:

1. Adding users and RFID cards

• Go to the Card database tab in the device interface.
• Add a new RFID card to database and input a user name.
• Apply the RFID card to the reader - press Get last read UID.
• Save changes. Repeat for each user.

2. Relay output configuration

• Go to the IO Settings tab.
• In the Out #0 Mode section, set mode to On Period.
• In the Out #0 Time section, input relay activation time (eg. 20 = 2 seconds).
• Save changes.

3. Defining card read action

• Go to the Card actions tab,
• In the On-known section (action on a known card) select:
  • Sound: Accept (card accepted signal),
  • Output #0: period (relay activated for a predefined period),
  • LCD text: Access granted,
  • LCD Text Timeout 5 seconds (text display time).
• Save changes

4. Testing the configuration

• Apply the previously added RFID card to the reader.
• The device should make a sound, display the Access Granted message and activate the relay for 2 seconds.
• Check if the relay drives the door opener correctly.

Result:
When an authorized user applies a card to the reader, the doors are unlocked for a predefined period of time. Access will be denied if a card is not present in the database.

Example 2: Recording of work time

Objective: Using the BoxID LED HF for recording entering and exiting employees with the use of RFID cards.

Configuration:

1. Adding users and RFID cards

• Go to the Card database tab in the device interface,
• Add a new RFID card to database and input a user name,
• Apply the RFID card to the reader - press Get last read UID,
• Save changes. Repeat for each user.

2. Event logging configuration

• Go to the Card actions tab,
• In the On-known section, set:
  • Sound: Accept (card accepted signal),
  • LCD text: Hello, [name]!,
  • Log event: Enabled (enables event logging in the system),
• In the On unknown section, set:
• Sound: Reject (card rejected signal),
• LCD text: Card unknown!,
• Save changes.

3. Sending data to the server

• Go to the Services/MQTT tab and enable event sending with MQTT,
• Configure the sever address (Broker) to which data about applied cards should be sent,
• In the On-new section, add information about the user to be sent:
• MQTT topic: rfid/logs,
• MQTT payload: {"user": "@last UID number", "time": " @current date and time"}.

4. Testing the configuration

• Apply the card to the reader,
• The screen should display the welcome message, and log the event in the system,
• Make sure the data has been sent correctly or saved in device logs.

Result:
Every RFID card use is logged and can be used to record working hours. Integration with a HR or ERP system allows for automatic computing of work time and generating a report.

Example 3: Automatic lighting control

Objective: Using the BoxID LED HF to control lighting with RFID card authorization.

Configuration:

1. Connecting the device to the lighting system

• Connect the relay controlling the lighting to OUT1 or OUT2 device output,
• Check if the relay turns the lighting on an off correctly.

2. Setting the RFID card read reaction

• Go to the Card actions tab,
• In the On-known section, set:
  • Sound: Accept (card accepted signal),
  • LCD text: Lights ON,
  • Output #0: On Period (relay activated for a predefined time),

• In the On-remove section, set:
  • Sound: None,
  • LCD text: Lights OFF,
  • Output #0: Off (relay deactivation after the card is removed).

• Go to the I/O Settings tab,
• In the Channels section, set:
  • Out #0 Time - eg. 3000 (5 minutes),
• Save changes.

3. Testing the configuration

• Apply the card to the reader,
• The lighting should be turned on for a predefined time,
• After the card is removed, the lighting should be turned off (If On-remove has been configured).

Result:
The system allows for automatic lighting control eg. in offices, warehouses, or staff rooms. The lighting is activated only when it is needed, which makes energy saving possible.

Example 4: Recording of access attempts by unauthorized cards and sending the events to the Syslog server

Objective:
Monitoring of access attempt by use of unauthorized RFID cards and automatic transfer of information about such events to the central Syslog server.

Configuration:

1. Enabling syslog

• Go to Services/Syslog tab in the device interface,

• In the Syslog Settings section:

  • Enable: Set ON to activate Syslog client,
  • Server: Input IP address or host name of the Syslog server,
  • Port: Set port number (default 514).

• Save changes.

2. Configuring the reaction for unauthorized cards

• Go to the Card actions tab,
• In the On-unknown section (action for unknown cards) set:
• Sound: Reject (card rejected signal),
• LCD Text: Unauthorized access! – message displayed on the screen,

• Log event: Make sure this option is enabled, for the event to be logged and sent to the Syslog server.

• Save changes.

3. Testing the configuration

• Use an RFID card that is not saved in the device database (unauthorized).
• The device should:
  • Make a card rejected signal,
  • Display the Unauthorized access! message,
  • Register the event locally and send it to the configured Syslog server.

Result:
The system automatically monitors and registers access attempts with unauthorized RFID cards. Events sent to the Syslog server allow for central monitoring and swift reaction in the case an unauthorized access is detected.

Example 5: Basic access control system using Lua script

Description:
The following script demonstrates the basic access control logic using functions of the BoxID LED HF. The script executes the following actions:

• rfid_detect()
  Function enabled when the RFID subsystem detects a card and reads its UID. In this function, the UID read may be modified or simply recorded.

• action_oncard()
  Function recalled when the system recognizes a card. A check is conducted, whether the UID corresponds to an authorized card (eg. "12345678"). If yes, action_known() function is recalled. If not, action_unknown is recalled.

• action_known()
  If a card is authorized, the system grants access - displays the "Access Granted" message, activates the relay output (eg. opening the door), plays the card accepted signal, and sets a timeout after which the output is deactivated.

• action_unknown()
  If a card is unauthorized, the system rejects access - displays the "Access Denied" message, plays the card rejected signal and blocks the access attempt.

• action_hold()
  Enabled when a card remains near the reader for too long. In an extended version:

  • Displays the "Card Hold Mode" message,
  • Flashes the relay output (channel 0) – 3 cycles, 200 ms on, 200 ms off,
  • Logs the long card hold event.

• action_remove()
  Function recalled when the card is removed from the read area. Frequently used to clear the display and log the event.

Implementation instructions:

1. Open the Lua Scripts tab:
   Log in to the BoxID LED HF interface and go to Lua Scripts tab.

2. Paste the script:
   Copy the following code to the script editor.

3. Save and upload:
   Save the changes and upload the script to device using the Load to module button.

4. Test the operation:
   Apply a card to the reader:

   • If card UID is "12345678", the system grants access, activates the relay output, displays the Access granted message and plays the card accepted signal.
   • For other UID's, the system denies access, displays the Access Denied message and logs the access attempt.
   • Holding the card will recall the action_hold() function, removing it - action_remove().
   • Hold the card for a longer time to recall the action_hold() function. You will see the "Card hold mode" message, and the relay output will start to flash.
   • Removing the card will recall the action_remove() function, which clears the display.

Lua Script:

-- Basic functions that are always executed.
-- Important! Even if you do not use the function, do not delete it; just leave it empty.

-- Function recalled when the RFID subsystem detects a card and reads its UID.
function rfid_detect()
    local uid = rfid.getUidAscii()  -- Read card UID in ASCII format.
    dev.console("RFID detected, UID: " .. uid)
    -- Optionally you can modify the UID, eg. convert it to the decimal format.
end

-- Function recalled when the system recognizes the card.
function action_oncard()
    local uid = rfid.getUidAscii()
    dev.console("Card presented, UID: " .. uid)
    -- Checking if the card is authorized (UID eg. "12345678")
    if uid == "12345678" then
        action_known()
    else
        action_unknown()
    end
end

-- Function recalled when the card is recognized as authorized.
function action_known()
    dev.console("Known card. Access granted for UID: " .. rfid.getUidAscii())
    dev.lcd_clear()
    dev.lcd_text("Access Granted", 1)
    dev.out_on(0)          -- Activate the relay output (eg. open the door)
    dev.buzz(0)            -- Play the card accepted signal (tone 0)
    dev.set_timeout(3000)  -- Set timeout to 3000 ms (3 seconds)
end

-- Function recalled when a card is recognized as unauthorized.
function action_unknown()
    dev.console("Unknown card. Access denied for UID: " .. rfid.getUidAscii())
    dev.lcd_clear()
    dev.lcd_text("Access Denied", 1)
    dev.buzz(1)           -- Play the card rejected signal (tone 1)
    dev.log("Unauthorized access attempt, UID: " .. rfid.getUidAscii())
end

-- Function recalled when the card remains in the read area for a longer time.
function action_hold()
    dev.console("Card held too long.")
    dev.lcd_clear()
    dev.lcd_text("Card Hold Mode", 1)
    -- Additional option: flashing the relay output (channel 0).
    dev.out_blink(0, 200, 200, 3)  -- 3 cycles: 200 ms on, 200 ms off
    dev.log("Card held for extended period, UID: " .. rfid.getUidAscii())
end

-- Function recalled, when a card is removed from the read area.
function action_remove()
    dev.console("Card removed.")
    dev.lcd_clear()
end

Example 6: Transfer of device data via HTTP

Objective: Transfering device data in the form of HTTP requests: ping, card application and removal information.

Configuration:

1. Setting HTTP parameters and adding the ping request syntax

• Go to the Services / HTTPc tab,
• Enable HTTP Client,
• Input the server parameters: IP address into the Server field and Port,
• Set the selected HTTP Method and Content type (we will be using the POST method and json content type for the purpose of this demonstration),
• In the Resource field, input the resource, to which the data will be sent,
• Depending on your needs, input the user name and password to the corresponding fields,
• Set the time interval between consecutive ping requests (in seconds),
• Type the request syntax into the HTTP ping request field, eg.

{"Action":"ping",
"Model":"%mod_model%",
"DeviceName":"%mod_name%",
"DateTime":"%timedate%"}

• Set the encryption parameters and upload certificates if needed,
• Save the changes.

2. HTTP request actions setting

• Go to the Card actions tab and select the desired action (On-new, informing about card application in this case),
• Select HTTP Request,
• Choose the HTTP method,
• Select the data format,
• Enter the request syntax eg.:

{"Action":"newcard",
"Model":"%mod_model%",
"DeviceName":"%mod_name%",
"CardID":"%uid%",
"DateTime":"%timedate%"}

• Save the changes

Likewise, configure the On-hold and On-remove actions if needed:

3. Test the configuration

• In the HTTP server's terminal, verify if the BoxID sends:
• Ping requests according to the interval set,
• Information about RFID card application to the read field,
• Information about card removal from the read field.

Result:

The device sends ping requests at specified intervals. Moreover, it informs the server about the fact that a card has been applied/removed to/from the read field, taking note of the event time and date.

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.

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 / Restoring user settings

All configuration data can be saved to a file. The user can create/upload the backup file on the Administration / Backup page.

Backup
Creation of a configuration data save requires a password.

Uploading the backup
Uploading the backup configuration data requires a password and selecting the file from the computer using the Choose file and Upload buttons.

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

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

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.

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.