> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Sensibo plugin

> Read and control Sensibo smart AC controllers (pods), their schedules, timers, Climate React and sensor history.

Use **Sensibo** through Corsair: one client, typed API calls, local DB sync.

Things to know before you call:

* **The key goes in the query string.** Sensibo takes the API key as the `apiKey` query parameter; the client sends no bearer token. Create a key at home.sensibo.com/me/api. With no key stored, Corsair raises `AuthMissingError` before any request; a key Sensibo rejects comes back as HTTP 403.
* **Ask for the fields you need.** `devices.list` returns only pod ids unless you pass `fields` (`*` for everything, or a list such as `id,room,acState,measurements`).
* **AC values come from the pod's remote.** Valid `mode`, `fanLevel`, `swing` and `light` values are in the pod's `remoteCapabilities` (`devices.get` with `fields: '*'`). An AC state can be partial, such as `{ on: false }`.
* **Writes change a real air conditioner.** `acStates.set`, timers, schedules and Climate React act on the physical unit. `timer.set` and `climateReact.configure` replace the current timer or Climate React settings.
* **Unknown ids are 404.** A pod or sensor that is not on the account answers 404 "No such device or device is not associated with user".

**What you get:**

* 19 typed API operations
* 1 synced entity (`pods`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/sensibo better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/sensibo better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/sensibo better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/sensibo better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { sensibo } from '@corsair-dev/sensibo';

export const corsair = createCorsair({
	plugins: [
		sensibo(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Sensibo API key before the first call: `pnpm corsair setup --plugin=sensibo --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> sensibo()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'sensibo',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List Sensibo pods with their rooms and AC state**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.sensibo.api.devices.list({ fields: 'id,room,acState' });
```

**Turn the AC on in cool mode at 22 degrees**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.sensibo.api.acStates.set({
	deviceId: 'abc123',
	acState: { on: true, mode: 'cool', targetTemperature: 22 },
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/sensibo/api.md) page.

## Query synced data

Synced entities support `tenant.sensibo.db.<entity>.search()` and `.list()`: `pods`.

See [Database](https://docs.corsair.dev/plugins/sensibo/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/sensibo/api.md)
>
> Every `sensibo.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/sensibo/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.