# Hotel-Room Object

### Introduction

The **Hotel-Room Object** is a **virtual device** inside the CU3 central unit.

* It is designed specifically for **hotel and hospitality projects**.
* It aggregates all **guest, room, and climate functions** into a single object.
* Information is automatically available for **Reception software, PMS (Property Management Systems), and BMS (Building Management Systems)**.

With the Hotel-Room Object, you no longer need to handle multiple devices or signals separately – everything is **unified in one place**.

### Benefits of the Hotel-Room Object

* Instead of configuring dozens of signals separately (occupancy, DND, HVAC setpoint, fan speed, etc.), all values are **consolidated in one object**.
* For PMS/BMS integration, the system only needs to subscribe to **one MQTT topic per room**, which minimizes complexity and errors.
* Housekeeping instantly sees **MUR and DND signals** in the PMS → no wasted trips to rooms.
* Maintenance teams can monitor **HVAC performance** (temperature, humidity, valve status) remotely.
* Reception has **real-time visibility** of guest presence, alarms, and scenes.
* Fewer manual processes → **lower staffing costs and higher efficiency**.
* Works equally well for **small boutique hotels** or **large multi-building resorts**.
* Each CU3 can handle more than one Hotel-Room Objects, and each object has the same interface.
* Hotels are free to use the iNELS Hotel Reservation Software (iHRS) or connect to **3rd-party PMS/BMS systems**.
* The open MQTT/JSON interface ensures compatibility with **cloud-based platforms, custom dashboards, or mobile apps**.

<figure><img src="https://407891681-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FErjlplToL8l7jIChGVB2%2Fuploads%2FEjmRlPkCHu7R8gq6yC6X%2Fimage.png?alt=media&#x26;token=924a54ff-8a55-4de1-8e69-2780e03cb18f" alt=""><figcaption></figcaption></figure>

### 2. Main Features

* **Guest & Room Status** → Occupancy, Do Not Disturb (DND), Make Up Room (MUR), Butler/Service call.
* **Climate Control** → Actual temperature, humidity, dew point, setpoints, correction.
* **HVAC Control** → Mode, plan, fan speed.
* **Room Events** → Door/window status, card events.
* **Scenes** → Welcome scene + 5 customizable room scenes.
* **MQTT Integration** → One topic per room, JSON payload for easy PMS/BMS integration.
* **Bidirectional** → Both **read status** and **write control** are supported.

### 3. Parameters in iDM

You need to have lated iDM version to have the Hotel object to be available in your project. it is also necessary to update the FW of CU.&#x20;

When you add a **Hotel-Room Object** in iDM, you will see:

* **Address**: Unique identifier of the object in CU3
* **Name/Description**: For project documentation
* **Room-ID**: Numeric value (0 – 65535) → links object to the hotel room number

### 4. Device Structure

The Hotel-Room Object contains the following datapoints:

#### Guest & Room Status

* **Occupancy** → Guest in room (true/false)
* **DND** → Do Not Disturb
* **MUR** → Make Up Room
* **Buttler** → Service call

#### Climate Control

* **Actual Temperature**
* **Required Heat Setpoint**
* **Required Cool Setpoint**
* **Correction** (calibration offset)
* **Humidity**
* **Dew Point**

#### HVAC Control

* **Control** → Heat / Cool / Off
* **Control Mode** → Plan / Manual / Eco / Dry etc.
* **Control Plan** → Base / Holiday / Public Holiday
* **Fan Speed** → Low / Medium / High / Auto / Off

#### Room Events

* **Door Status** → Open/Closed
* **Window Status** → Open/Closed

#### Scenes

* **Welcome Scene**
* **Scene 1 – Scene 5** (customizable)

### 5. Linking in iDM

* Add a **Controller for Heating and Cooling (HCA)** in **System Manager**.
* Under **Connections**, select the **Hotel-Room Object**.

<figure><img src="https://407891681-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FErjlplToL8l7jIChGVB2%2Fuploads%2Fq9F3K1CXz0Hzyu8txHh8%2Fimage.png?alt=media&#x26;token=c8c70cfc-a797-4e81-9b9c-140c33297f8b" alt=""><figcaption></figcaption></figure>

* iDM will automatically create internal wires between the Hotel-Room Object and the HCA.
* Input climate data wire automatically to HCA. Like Actual Temperature, Required Heat Setpoint, Required Cool Setpoint, Correction (calibration offset), Humidity, Dew Point

{% hint style="warning" %}
**Important**: You must still wire the HCA outputs (Fan regulator, Valve regulator) to the **physical output relays or analog outputs** controlling the HVAC equipment.
{% endhint %}

### 6. MQTT Integration

#### Topic Structure

* **Status (publish)**

  ```
  inels/status/<CU3_MAC>/Hotelroom/<HotelRoom_Address>
  ```
* **Set (subscribe)**

  ```
  inels/set/<CU3_MAC>/Hotelroom/<HotelRoom_Address>
  ```

#### Example Status Payload

```json
{
  "timestamp": "2025-08-25T18:45:52Z",
  "room_id": "1",
  "occupancy": false,
  "dnd": false,
  "mur": true,
  "buttler": true,
  "temperature": {
    "current": 23.5,
    "set_heat": 22,
    "set_cool": 24,
    "correction": 1
  },
  "humidity": 55,
  "dew_point": 14.8,
  "control": "Heat",
  "control_mode": "Plan",
  "control_plan": "Base",
  "fan_speed": "Low",
  "door_status": "Closed",
  "window_status": "Closed",
  "scenes": {
    "welcome_scene": true,
    "scene_1": false,
    "scene_2": true,
    "scene_3": false,
    "scene_4": true,
    "scene_5": false
  }
}
```

***

#### Example Set Payload

```json
{
  "dnd": true,
  "mur": false,
  "buttler": false,
  "temperature": {
    "set_heat": 21,
    "set_cool": 24,
    "correction": 0
  },
  "control": "Cool",
  "control_mode": "Manual",
  "control_plan": "Holiday",
  "fan_speed": "Auto",
  "door_status": "Closed",
  "window_status": "Closed",
  "scenes": {
    "welcome_scene": false,
    "scene_1": true,
    "scene_2": false,
    "scene_3": false,
    "scene_4": false,
    "scene_5": true
  }
}
```

### Payload Reference

#### Fan Speed&#x20;

| Key | Name | Description                 |
| --- | ---- | --------------------------- |
| 0   | Low  | Fan at low speed            |
| 1   | Med  | Fan at medium speed         |
| 2   | Hi   | Fan at high speed           |
| 3   | Auto | Automatic fan speed control |
| 4   | Off  | Fan switched off            |

#### HVAC control

| Key | Name | Description         |
| --- | ---- | ------------------- |
| 0   | Cool | Cooling mode active |
| 1   | Heat | Heating mode active |
| 2   | Off  | System switched off |

#### HVAC Modes&#x20;

| Key | Name | Description         |
| --- | ---- | ------------------- |
| 0   | Cool | Cooling mode active |
| 1   | Heat | Heating mode active |
| 2   | Off  | System switched off |

Control Modes

| Key | Name      | Description                  |
| --- | --------- | ---------------------------- |
| 0   | Plan      | Follow scheduled plan        |
| 1   | Favorite1 | User-defined favorite mode 1 |
| 2   | Favorite2 | User-defined favorite mode 2 |
| 3   | Favorite3 | User-defined favorite mode 3 |
| 4   | Favorite4 | User-defined favorite mode 4 |
| 5   | Fan       | Fan-only mode                |
| 6   | Eco       | Energy-saving mode           |
| 7   | Manual    | Manual override mode         |
| 8   | Dry       | Dehumidification mode        |

#### Plan Control Modes

| Key | Name           | Description                        |
| --- | -------------- | ---------------------------------- |
| 0   | Base           | Base (default) plan                |
| 64  | Holiday        | Holiday plan                       |
| 128 | Public Holiday | Public holiday plan (special case) |