iobroker.fakeroku

v1.10.0

Published

17 days ago

ioBroker adapter that emulates Roku devices, letting ECP/SSDP remotes (Logitech Harmony, Sofabaton) trigger events in ioBroker

ioBroker.fakeroku

Release: stable Installations

Build:

Support:

[!IMPORTANT] This adapter cannot be installed from github

Emulates one or more Roku devices on your LAN so that a Logitech Harmony Hub or a Sofabaton X1/X2 can trigger events in ioBroker. It is the input counterpart to the Logitech Harmony adapter: a button on the remote becomes a datapoint in ioBroker.

Besides the key presses it answers what these remotes read when they pair — device info, app list, app icons.

The official Roku mobile app is not supported. It drives Rokus over Roku's proprietary, undocumented ECP-2 WebSocket channel, which this emulator does not implement. Use a Harmony hub or a Sofabaton — those speak the classic ECP this adapter serves.

🇺🇸 Documentation · 🇩🇪 Dokumentation

Features

Emulates one or more Roku devices on the LAN — the Roku control protocol (ECP) over HTTP plus SSDP discovery on port 1900.
Answers the Roku queries controllers rely on: device info, apps, active app, media player, TV channels and app icons.
Clean data model per device: a command datapoint plus fixed keys.<Key> states, all created up front.
Several emulated Rokus from a single instance; with "all interfaces" every network of the host is served with the host's own address in it, a chosen interface keeps everything in its network; only clients from the host's own networks are answered, capped at 25 commands per second per emulated Roku, so a misbehaving device cannot flood ioBroker. Releasing a key you are holding is never dropped by that cap.

Sentry / Error reporting

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. Reporting is active by default. It stays off when the ioBroker diagnostics setting is none (diag in the system configuration), when data reporting is disabled for this instance or its host (disableDataReporting), and on CI systems. A report contains the error with its stack trace and technical context such as versions and platform, plus an anonymous installation ID.

For details and how to disable it, see the Sentry plugin documentation. Error reporting requires js-controller 3.0 or newer.

Requirements

Node.js >= 22
js-controller >= 7.2.2
admin >= 8.0.14

Ports

TCP 8060 (listening, one per emulated Roku, configurable) — the Roku control protocol (ECP): the remote sends its key presses here.
UDP 1900 (multicast, listening and outgoing) — SSDP discovery, so a Harmony hub or Sofabaton finds the emulated Rokus; fixed by the UPnP standard.

Configuration

Network interface — leave it on "all interfaces" and the adapter runs out of the box: every network of the host is served, each with the host's own address in it. Pick a specific address only if the emulated Rokus should exist in one network only — then everything stays in that network. An address the host does not carry is waited for up to two minutes at start-up, then reported; the adapter never falls back to another network.
Emulated Roku devices — managed as cards: + Add opens a dialog with a name, an ECP port (8060 the real Roku port; a free one is pre-selected, and the dialog does not let you confirm a name or port already in use) and a type. You can emulate several Rokus from one instance — each needs its own port. Renaming a card keeps its datapoints, their room and function assignments and their history settings.
Type — Player (default) exposes the 16 standard navigation and playback keys; TV additionally exposes volume, power, channel and input keys. Choose TV only if you want those extra keys as ioBroker triggers.

To add the emulated Roku to a Harmony hub, add a "Roku" device in the Harmony app and point it at the ioBroker host.

State Tree

At instance level:

| Datapoint | Type | Meaning | |---|---|---| | info.connection | boolean, read-only | true only while everything runs: every configured Roku listens, discovery answers, and the chosen address exists. Anything less shows the instance yellow; the log names the cause once, and the adapter retries a Roku or discovery that is down every minute. | | info.devicesTotal | number, read-only | How many emulated Rokus are configured. | | info.devicesOnline | number, read-only | How many of them listen right now. | | info.devicesAllOnline | boolean, read-only | true while every configured Roku listens; false while none is configured. |

For every emulated Roku (fakeroku.0.<name>):

| Datapoint | Type | Meaning | |---|---|---| | .info.online | boolean, read-only | true while this Roku listens on its port. The device shows a green or grey symbol in the object tree, its card in the device manager online or offline. | | .info.error | string, read-only | Why this Roku does not run, e.g. port 8061 is already in use (another program or another instance holds it); empty while it runs, Unknown while the adapter is off or starting. The card shows it as a warning. | | .command | string, read-only | The last command as plain text (Home, Lit_a, launch:12, search:news). One datapoint for everything — no object-per-character sprawl. | | .keys.<Key> | boolean, read-only | One state per remote key the device type exposes — a Player has the 16 navigation/playback keys, a TV adds Volume*, PowerOn/PowerOff/Power, Sleep, Channel*, Tuner/HDMI/AV inputs — all created up front. A keypress pulses it true for a moment; keydown/keyup hold it. Key names are read in any case (home is Home). |

Free keyboard input (Lit_x) and app launches show up in .command only — they do not get their own objects. An app button of a remote that sends app launches (a Sofabaton) arrives as launch:<id>; a Harmony Hub did not send its app buttons to the emulated Roku.

Note: the Roku remote sends the same Play command for play and pause, so play and pause cannot be told apart here — that is a protocol limitation, not an adapter one.

In a script or Blockly rule, react to a key — e.g. when fakeroku.0.<name>.keys.Play becomes true — or watch .command for the last button as text.

Changelog

1.10.0 (2026-10-03)

(krobipd) New: every emulated Roku shows whether it runs and, if not, why — a green or grey symbol in the object tree, online or offline on its card with the reason.
(krobipd) New: three datapoints count the emulated Rokus — how many are configured, how many run, and whether all of them run.
(krobipd) Fixed: the connection datapoint's description says what green means — every Roku listening, discovery answering and the chosen address present.

1.9.0 (2026-10-03)

(krobipd) Changed: the emulated Roku answers only what a Harmony or Sofabaton reads — Home Assistant and openHAB can no longer set it up.
(krobipd) Changed: the instance shows green only while every Roku and discovery run, and yellow otherwise.
(krobipd) Changed: a Roku whose server stopped while running and a discovery that failed start again within a minute instead of waiting for a restart.
(krobipd) Changed: with no Roku configured or none running, the instance stays up so the device manager works, and asks you to add a Roku.
(krobipd) Changed: a chosen address that is missing on the host no longer leaves the Rokus off — they listen on all addresses until you choose another.
(krobipd) Changed: requests from the ioBroker host itself or from self-assigned addresses outside the host's networks are refused.
(krobipd) Changed: the datapoint with the kind of the last command is gone — the last command itself still arrives as before; existing installations drop it on the next start.

1.8.2 (2026-10-02)

(krobipd) Changed: a new instance starts switched off — check the settings, then switch it on.
(krobipd) Fixed: the README and the user documentation name admin 8.0.14, the version the adapter actually requires.
(krobipd) Fixed: the device manager answers right after a restart instead of failing until the translations are loaded.
(krobipd) Improved: the type of the last command shows a readable label in the language you set instead of a protocol word.
(krobipd) Improved: a start writes only datapoints that changed and reads the key states in one request — no needless updates for history adapters.
(krobipd) Improved: the README links the detailed user documentation in English and German.

1.8.1 (2026-09-27)

(krobipd) Improved: the note the Admin shows before an update from 0.x is short now: the apps folder is removed, app launches arrive as launch: in command.

1.8.0 (2026-09-25)

(krobipd) Fixed: Home Assistant and openHAB can set up the emulated Roku again — it now answers the active-app, media-player and TV-channel queries they send.
(krobipd) Fixed: keys sent in any upper or lower case (home, POWERON) press the right button, and spaces typed in Home Assistant arrive as spaces.
(krobipd) Fixed: an upgrade from the old adapter keeps every object tree with its rooms and history, also for names with an umlaut, a bracket or a double space.
(krobipd) Fixed: renaming a device only changes its displayed name; its datapoints and scripts pointing at them stay where they are.
(krobipd) Fixed: an instance started before the network is up starts its devices and adds discovery as soon as the host has an address.
(krobipd) Fixed: the device dialog greys out OK for a taken name or port and says why.
(krobipd) Changed: only devices in the host's own networks are answered; a chosen network interface keeps everything in its network and is never swapped for another.
(krobipd) Changed: a chosen network interface that does not exist is waited for up to two minutes at start, then reported, instead of being replaced.
(krobipd) New: the TV profile adds the PowerOn, Power, Sleep and InputTuner keys and announces itself the way real Roku TVs do.
(krobipd) New: every new emulated Roku gets its own network identity instead of one every installation with the same name would share.

Older changelogs can be found there

History

fakeroku has a long lineage on ioBroker, and this version continues it — for existing users it is simply a new version of the same adapter:

Pmant created fakeroku in 2017 and built the original Roku emulation: SSDP discovery, the ECP surface and multi-device support.
Apollon77 kept the test and build tooling current over the following years.
The ioBroker Community Adapters team — notably mcm1957 and foxriver76 — maintained and modernized the adapter from 2023 to 2026, releasing versions up to 0.5.1.
From 0.6.0 on, krobi rewrote the adapter from the ground up in TypeScript and added the full ECP surface including device-info.

Support

Support Development

This adapter is free and open source. If you find it useful, consider buying me a coffee:

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.