Configuration Guide¶
Preliminary Document
This is a preliminary guide. Product images are rendered previews. Component selection is ongoing. Content is subject to change without notice.
The EverTag Station is designed for the most efficient and easy-to-use Wirepas anchor and gateway installation possible. Multiple configuration methods are available depending on your variant and deployment scenario:
| Method | Available On | Requires | Best For |
|---|---|---|---|
| NFC via CB Admin app | All variants | NFC-enabled phone | Field provisioning, batch deployment, offline setup |
| WiFi Web UI | Gateway variants (232012, 232013) | WiFi connection to gateway | Advanced gateway configuration, diagnostics |
| Wirepas App Config | All variants (when connected) | Wirepas network + backend | Remote configuration of deployed devices |
| MQTT Remote Config | Gateway variants (232012, 232013) | MQTT broker connection | Cloud-based remote management (prepared for future use) |
1. NFC Configuration (All Variants)¶
NFC configuration uses the CB Admin app to write settings directly to the device via NFC. This works on every EverTag Station variant — anchors and gateways alike. No WiFi or internet connection is needed.
1.1 Prerequisites¶
- NFC-enabled smartphone (iOS or Android)
- CB Admin app installed (App Store / Google Play)
- Wirepas network parameters from your network administrator
For a list of compatible phones, see the Supported Phones page.
1.2 Configurable Parameters via NFC¶
CB Admin can write the following settings in a single NFC tap:
| Category | Parameters |
|---|---|
| Wirepas Sink | Network address, network channel, node address, node role, encryption key, authentication key, stack mode, sink cost |
| WiFi (gateway only) | Mode (AP/Station), SSID, password, band preference, country code, DHCP |
| MQTT (gateway only) | Broker URI, port, protocol, credentials, TLS certificates, data encoding |
| NTP (gateway only) | NTP server, sync interval |
1.3 Single-Tap Configuration¶
The simplest workflow for configuring one device at a time:
- Open CB Admin and create or select a configuration profile with your Wirepas network parameters (at minimum: network address, channel, keys).
- For gateway variants, optionally add WiFi, MQTT, and NTP settings.
- Hold your phone within 2 cm of the front face of the Connectivity Module (upper half of the enclosure).
- Tap — CB Admin writes the configuration via NFC. The device applies it immediately.
- The LED activates for 5 minutes after the tap, showing the current device status.
- Optional: tap again to read back the device status and confirm the configuration was applied.
1.4 Multi-Tap Batch Deployment¶
For deploying many devices with the same settings, CB Admin's Multi-Tap feature provides a fast tap-and-go workflow:
- Create a configuration profile in CB Admin with the desired network settings.
- Enable Multi-Tap mode from the settings menu.
- Select which settings to apply (checkboxes appear next to each parameter).
- Press "Update multiple tags" and walk to each EverTag Station.
- Tap each device — each one receives identical settings in a single tap.
- The device assigns itself a unique Wirepas node address automatically.
Multi-Tap is ideal for large-scale deployments where hundreds or thousands of anchors and gateways need consistent configuration. Each tap takes only 1–2 seconds.
Offline Capable
CB Admin stores profiles locally on your phone. No internet connection is needed during field deployment.
1.5 Configuration Profiles¶
CB Admin supports saved configuration profiles for repeatable deployments:
- Create profiles with all required Wirepas, WiFi, and MQTT settings for a specific site or project.
- Password-protect profiles to prevent unauthorized modification.
- Share profiles with team members or external installers — send a profile file and they can import it into their CB Admin app.
- Reuse profiles across multiple projects or sites with similar network settings.
Profiles ensure consistent configuration across all devices in a deployment and reduce the risk of manual entry errors.
1.6 NFC PIN Security¶
The EverTag Station supports an NFC PIN code to prevent unauthorized access to device configuration:
- When an NFC PIN is set, CB Admin must provide the correct PIN before reading or writing device settings.
- If the wrong PIN is entered, access is denied.
- The default PIN is
12345678. Change it during initial deployment to secure your devices. - The NFC PIN can be set via CB Admin (single-tap or multi-tap) or via the Wirepas network (command 0x18).
Set NFC PIN Before Deployment
For devices installed in publicly accessible locations, always set a unique NFC PIN to prevent unauthorized configuration changes.
2. WiFi Web UI (Gateway Variants Only)¶
Gateway Variants Only
The WiFi Web UI is available only on gateway variants (232012, 232013). Anchor-only variants (232010, 232011) do not have WiFi hardware.
Gateway variants run a built-in web interface on the ESP32-C5 WiFi module. The Web UI provides full configuration, diagnostics, and mesh packet viewing.
2.1 Connecting to the Web UI¶
The gateway starts in Access Point (AP) mode by default:
- On your laptop or phone, connect to the gateway's WiFi network:
- SSID:
ETGW-<serial>(serial is printed on the device label) - Password:
evertag
- SSID:
- Open a browser and navigate to
http://192.168.4.1 - Log in with the default password:
evertag
After switching the gateway to Station mode (connected to your site WiFi), access the Web UI via:
- The DHCP-assigned IP address (check your router's client list)
http://ETGW-<serial>.local(mDNS, if supported by your network)
2.2 Web UI Tabs¶
| Tab | Purpose |
|---|---|
| Device | Read-only device information: firmware versions, system time, uptime, network interfaces, service status, diagnostics |
| Configuration | All configurable settings: WiFi, Wirepas Sink, MQTT broker, NTP |
| Nodes | Live Wirepas mesh packet viewer (real-time table via WebSocket) |
2.3 Key Configuration Sections¶
WiFi¶
| Setting | Description |
|---|---|
| Mode | Access Point (commissioning) or Station (production) |
| SSID / Password | Network name and credentials |
| Band preference | Auto, 5 GHz only, or 2.4 GHz only. Use 5 GHz to avoid Wirepas 2.4 GHz interference. |
| Country code | Regulatory domain for channel/power compliance |
Wirepas Sink¶
| Setting | Description |
|---|---|
| Stack mode | When to start the Wirepas stack (on network up, permanently, disabled, on MQTT connect) |
| Network address / channel | Wirepas mesh network identifiers |
| Node address / role | Unique address and role (Sink or Router) |
| Encryption / auth keys | 128-bit Wirepas network keys |
MQTT¶
| Setting | Description |
|---|---|
| Protocol | mqtts:// (TLS, recommended), mqtt://, wss://, or ws:// |
| Broker URI / Port | MQTT broker hostname and port |
| Credentials | Username and password (optional) |
| TLS certificates | CA cert, client cert, client key for mutual TLS |
NTP¶
| Setting | Description |
|---|---|
| NTP server | Hostname (default: pool.ntp.org) |
| Sync interval | 5 minutes to 24 hours |
For the complete Web UI specification with all fields, options, and architecture details, see the Gateway Web UI Specification.
2.4 Typical Gateway Setup Flow¶
- Connect to the gateway AP and open the Web UI.
- Go to Configuration → WiFi: set mode to Station, enter your site WiFi SSID and password, select 5 GHz band preference. Save.
- The gateway disconnects from AP mode and joins your site WiFi. Reconnect your laptop to the same site WiFi.
- Browse to the gateway's new IP or
http://ETGW-<serial>.local. - Go to Configuration → Sink: set network address, channel, and keys to match your Wirepas network. Save.
- Go to Configuration → MQTT: enter the broker URI, port, and credentials. Upload TLS certificates if required. Save.
- Check the Device tab: verify that Sink service is running, MQTT transport is connected, and the LED shows green.
3. Wirepas App Config (All Variants)¶
Once a device is connected to a Wirepas Mesh network, it can receive configuration updates remotely via the Wirepas application configuration protocol. This allows changing device parameters without physical access.
Wirepas App Config supports:
- Broadcast: update all anchors or all tags in a network at once.
- Unicast: update a single device by address.
- Multicast: update a specific group of devices.
Configurable parameters include LED patterns, device control (reboot, factory reset, power down), tampering detection, and information requests. The EverTag Station inherits the same configuration command set as the EverTag tag family. For details, see the EverTag User Guide — Configuration over Wirepas Network.
Configuration is sent via the Wirepas backend (e.g., using Wirepas Network Tool). NRLS devices receive the configuration on their next wake-up cycle; connected devices (anchors, gateways) receive it within seconds.
4. MQTT Remote Config (Gateway Variants — Prepared)¶
Future Capability
MQTT remote configuration is architecturally prepared but not yet implemented. The gateway's MQTT transport and command interface are designed to support remote configuration in a future firmware release.
Gateway variants (232012, 232013) connect to an MQTT broker for relaying Wirepas mesh data. The same MQTT connection can be used for remote device management, enabling:
- Cloud-based configuration — push WiFi, MQTT, and Wirepas settings from a central management platform.
- Fleet management — update configuration across all gateways in a deployment without physical access.
- Monitoring — query device status, firmware version, and health remotely.
5. Configuration Precedence¶
The device flash is the single source of truth for all configuration. When configuration arrives from multiple sources:
| Scenario | Behavior |
|---|---|
| NFC config arrives while Web UI has unsaved changes | NFC wins. Web UI reflects new values on next refresh. |
| Web UI saves while NFC is idle | Web UI changes are stored in flash. |
| Wirepas App Config arrives | Applied and stored. Overrides previous values for the affected parameters. |
| Factory reset (hold button while plugging in power for 10 s) | All configuration erased. Device returns to defaults. |
6. Default Values¶
| Setting | Default |
|---|---|
| WiFi mode | Access Point |
| WiFi SSID | ETGW-<serial> |
| WiFi password | evertag |
| Web UI password | evertag |
| WiFi band | Auto |
| MQTT protocol | mqtts:// |
| MQTT port | 8883 |
| NTP server | pool.ntp.org |
| NTP interval | 24 hours |
| Sink stack mode | Sink enabled on network up |
| Sink node role | CSMA-CA Sink (Low Latency) |
Change Default Passwords
Change the default WiFi and Web UI passwords before deploying in production. The defaults are intended for initial commissioning only.