Resource - Device

A Device in Wogeez represents a physical used within the platform, such as terminals, kiosks, or electronic payment terminals. Each device comes with a set of properties that define its status, capabilities, and interactions within the system. These properties include real-time indicators like health and battery status, operational controls such as available commands, and additional data points like connectivity details, software version, event history, and location.

Additionally, Wogeez provides a search API that allows users to efficiently find and filter devices based on their properties. Whether searching for devices with a low battery, those requiring maintenance, or filtering by software version, this capability enhances device management and operational efficiency.

By leveraging these properties and search functionalities, Wogeez ensures efficient monitoring and management of devices, enabling proactive maintenance, seamless updates, and an overall improved user experience.

Introduction

In a modular system, some devices act as hubs, serving as intermediaries between a main device and multiple sub-devices. A hub centralizes interactions, allowing the main device to utilize the functionalities of its sub-devices without managing them individually.

Each sub-device connected to a hub exposes capabilities (the functionalities it provides) and operating modes (the different ways these capabilities can be used). These elements are standardized by the Wogeez protocol, meaning there is no need to manage them manually unless specific monitoring of the device network is required. As a result, scenarios execute automatically based on the declared capabilities of each hub and sub-device connected to a terminal, with no additional intervention.

An Electronic Payment Terminal (TPE) is a great example of a multifunctional hub, centralizing multiple sub-devices that interact to process secure transactions and execute interactive scenarios.

Automation via the Wogeez Protocol

Thanks to the Wogeez protocol, these capabilities and modes are standardized and managed automatically. This means:

• You do not need to manually manage each hub and sub-device.
• Scenarios execute naturally based on the declared capabilities of each hub and sub-device connected to a terminal.
• Monitoring is optional: if you do not wish to supervise your device network in detail, the system will autonomously function by leveraging the capabilities of the connected equipment.

For example, if a TPE is connected to a terminal that has a card reader and a screen, the scenario will automatically adapt:

• If it detects a compatible screen, it will display user instructions.
• If a card reader is found, it will activate card insertion or contactless payment.
• If a network connection is available, it will automatically send transactions for validation. All of this happens without manual intervention, as the system identifies and utilizes the available equipment according to the Wogeez protocol rules.

The TPE as a hub model demonstrates how a device can integrate and manage multiple sub-devices, each with its own capabilities and operating modes, without requiring specific configuration. Thanks to the standardization provided by Wogeez, scenarios dynamically adapt to the existing infrastructure, ensuring a smooth and automatic experience for both users and system operators.

Example : A Kiosk with Two Hubs – A TPE and a Locker System

In this example, we have a kiosk acting as the main device, with two hubs connected:

1. A Payment Terminal (TPE) Hub – responsible for handling transactions.
2. A Locker System Hub – used for secure storage and automated retrieval of items.

Each hub has its own sub-devices, exposing capabilities and modes that allow the kiosk to operate efficiently.

Scenario:

1. The kiosk requests payment for a service.
2. The TPE Hub activates its payment UI mode, displaying the amount.
3. The user inserts a card, and the card reader activates its chip processing mode.
4. If required, the PIN pad switches to PIN entry mode for authentication.
5. Once validated, the network module transmits the transaction for approval.
6. The kiosk receives confirmation and triggers the next step.
7. The kiosk triggers the Locker System Hub to release a locker.
8. The RFID/NFC Reader verifies the user’s pickup code.
9. The Locker Control Unit switches to open mode, unlocking the assigned locker.
10. The LED interface updates to in use mode, indicating the locker is occupied.

Since the TPE Hub and Locker System Hub both expose their capabilities and modes using the Wogeez protocol, the kiosk can seamlessly manage the flow of operations:

• The system automatically detects available hubs and sub-devices.
• Payment and locker access execute naturally without manual intervention.
• If a component is missing (e.g., no RFID reader), the scenario adapts dynamically.

Remote Command Execution on sub-devices

In addition to exposing their capabilities and operating modes, sub-devices can receive remote commands via API to perform specific maintenance or operational tasks. These commands are structured with arguments that define their execution parameters, allowing real-time control and management of devices.

This feature enables automated maintenance, configuration, and diagnostics, ensuring that connected systems operate efficiently without requiring physical intervention.

To facilitate this process, the Wogeez WRCC mobile application provides an intuitive interface for sending commands directly to connected hubs and sub-devices, enabling seamless remote management.

Datasheet

Datasheet - Device connection state

State	Description
UNKNOWN	The connection status is unknown, typically during startup; will eventually switch to DISCONNECTED.
CONNECTED	The device is connected to the network; data is up to date and real-time communication is possible.
DISCONNECTED	The device is not connected to the network; it may still function normally, but data may be outdated.

Datasheet - Device capability

Capability	Description
SCENARIO	Predefined sequence of interactions that guide a user through a process on a terminal or kiosk, adapting dynamically based on available devices and user input
PRINTER	Physical printing of receipts, tickets, labels, or other documents
PAYMENT	Card processing, contactless payments, PIN entry, and transaction validation
GENERIC_MONITORING	It does not perform direct user interactions but instead collects and transmits real-time operational data for analysis and maintenance
WEB	WEB refers to a component that displays a web page within a system, such as on a kiosk screen, a payment terminal, or another interactive device
IOT	Reserved
GENERIC	Non-specific or adaptable component
GENERIC_USB	Non-specific or adaptable component
GENERIC_SERIAL	Non-specific or adaptable component
CDN	Deprecated
DATA	Deprecated
MEDIA	Deprecated

Datasheet - Device capability modes

Capability	Mode	Description
SCENARIO	SCENARIO_EXECUTE	Predefined sequence of interactions that guide a user through a process on a terminal or kiosk, adapting dynamically based on available devices and user inputs
PRINTER	PRINTER_PRINT	Physical printing of receipts and tickets
PAYMENT	PAYMENT_CARD_CONTACTLESS	Contactless payment (compatible with Android and Apple)
PAYMENT	PAYMENT_CARD_PHYSICAL	Physical payment
PAYMENT	PAYMENT_CARD_MAGNETIC	Magnetic card payment (deprecated)
GENERIC	GENERIC_BEEP	A simple beeper
GENERIC	GENERIC_LED	A simple WRGB LED
GENERIC	GENERIC_REBOOT	Perform a reboot (deprecated)
GENERIC_MONITORING	GENERIC_MONITOR_PRINTER	Information about printers
WEB	WEB_PAGE	An embedded browser to display a web-page

Datasheet - Device health state

State	Description	Example (for a printer)
BOOTING	The system is starting up and initializing necessary components.	The printer is starting up, detecting hardware, and configuring settings.
NOMINAL	The system is operating normally with no issues detected.	The printer is functioning correctly; all systems are operational.
WARNING	A minor issue has been detected; attention may be required.	Paper is running low or a minor issue has been detected.
DOWN	The system is offline or shut down; no operations are in progress.	The printer is out of paper or jammed; it cannot operate.
HIBERNATION	The system is in a low-power state to conserve energy.	The printer is in remote maintenance mode or standby to save energy.