Sofabaton X

About

Automatic summary of the README and code of m3tac0de/home-assistant-sofabaton-x1s. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

• Works locally Talks to your devices on your own network. No vendor cloud in between.

• Found by itself Home Assistant spots it on the network and offers to add it.

• From the Marketplace Installed through the Marketplace, formerly HACS.

• Actively maintained Its author released or pushed a change in the last six months.

Provides

• Remotes
• Switches
• Sensors

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Texts from the code of m3tac0de/home-assistant-sofabaton-x1s.

Entities

• Binary sensorsApp connected, Hub connected
• ButtonsFind remote, Synchronize remote, A button, B button, Back, Blue button, C button, Channel down, Channel up, Down, DVR, Exit, and 17 more
• infraredIR emitter
• RemotesRemote
• SelectsActivity
• SensorsActivity, Index, Wifi commands, Last intercepted IR command, Recorded keypress
• SwitchesHex logging, Proxy, Wifi device
• TextsHub IP address, Home Assistant IP address

Actions

• Back up hub bundleReturns a hub_bundle JSON payload. Omit device IDs to back up all devices and activities, or provide device IDs to back up only those devices.Fields: Sofabaton hub, Device IDs
• Map command to activity buttonMaps a command to a physical button in an activity on the selected hub.Fields: Sofabaton hub, Activity ID, Activity button ID, Device ID, Command ID, Long-press device ID, Long-press command ID
• Add command to activity favoritesAdds a command to an activity's favorites on the selected hub.Fields: Sofabaton hub, Activity ID, Device ID, Command ID, Favorite slot ID
• Create Wifi deviceCreates a Wifi device on the selected hub.Fields: Sofabaton hub, Device name, Custom commands, Power-on command ID, Power-off command ID, Input command IDs
• Delete deviceDeletes a device and confirms all affected activities on the selected hub.Fields: Sofabaton hub, Device ID
• Delete activity favoriteDeletes one favorite from an activity on the selected hub.Fields: Sofabaton hub, Activity ID, Favorite ID
• Add device to activityAdds a device to an activity on the selected hub.Fields: Sofabaton hub, Activity ID, Device ID, Input command ID
• Dump raw IR commandsRequests 0x020C [device_id, command_id] and returns parsed raw command blob pages for a device.Fields: Sofabaton hub, Device ID, Command ID
• Export hub snapshotReturns the structural hub_bundle the live Control Panel editor reads (cached proxy state only, no hub round trip and no per-command IR blob dump), plus the cache generation it was exported at. Pass that generation to the sync edited snapshot action's expected generation to catch a stale baseline. Requires the persistent cache to be enabled and populated. Edit the returned JSON offline and pass it back as the baseline and edited snapshots to write just the changed rows.Fields: Sofabaton hub
• Fetch normalized blobRequests 0x020C [device_id, command_id] and returns normalized command blob records, including the canonical body, removed checksum byte, and a parsed descriptor when available.Fields: Sofabaton hub, Device ID, Command ID
• Fetch commands for device or activityFetches and caches commands for an activity or device so they appear on the diagnostic sensor.Fields: Sofabaton hub, Activity or device ID
• Get activity favoritesFetches the ordered quick-access list for an activity, including favorites and macros with their order IDs, display slots, types, and labels.Fields: Sofabaton hub, Activity ID
• Save IR blobAdds a command to an existing IR device by staging the current command IDs, uploading a canonical command blob, and saving it on the hub.Fields: Sofabaton hub, Device ID, Command name, Blob or descriptor
• Set IR learn modeArms or disarms the hub's IR learning mode. While armed, the hub's IR receiver waits for a button press from the source IR remote. Arming always exits any previous learning session first. This action only toggles the mode; it does not wait for a captured code. Use Learn IR command for the full learn flow.Fields: Sofabaton hub, Enabled
• Learn IR commandArms the hub's IR learning mode and waits for one code from the source IR remote. The response reports what happened: learned (with the captured payload), timed_out (nothing was received), or interrupted (other hub traffic ended the learning window). No manual mode switching is needed.Fields: Sofabaton hub, Timeout
• Play IR blobStreams a command blob to the hub for one-time playback without saving it. Accepts a canonical blob body without its final replay-tail checksum byte or a descriptive protocol string such as P:Sony12 R:40000 D:1 F:18 MUL:2.Fields: Sofabaton hub, Blob or descriptor
• Reorder activity favoritesReorders an activity's favorites using their hub-order IDs.Fields: Sofabaton hub, Activity ID, Ordered favorite IDs
• Restore hub bundleRestores a hub_bundle JSON payload. Devices are restored first, followed by activities using the automatically generated device ID mapping.Fields: Sofabaton hub, Backup payload
• Send Pronto HexDecodes a learned-format Pronto Hex code (0000) and sends it through the hub's IR emitter. The emitter timestamp updates, and the Last intercepted IR command sensor records the payload prepared for the hub.Fields: Pronto Hex
• Synchronize command configurationDeploys the saved command-slot configuration by recreating the managed Wifi device and applying activity mappings.Fields: Sofabaton hub, Wifi Device, Device name, Wifi Device key

Troubleshooting

• DiagnosticsDownloads a diagnostics file to attach to a bug report.
• Repair noticesNotices it can show in Settings, Repairs:Sofabaton hub firmware update recommended

From the README