Skip to content

Add documentation for proxying connectivity options #188

Description

@mkerstner

In addition, to comply with our integration-lead documentation approach on home-assistant.io we need to also add respective sections for our new proxying / connectivity options.

We aim to add a "Remote adapters (proxying devices)" (=just a working title) section to the respective integration pages:

These sections can then also be used to link from e.g.

to better guide users on the requirements and underlying workings if needed.

Documentation proposal: Remote adapters (proxying devices)

1. Infrared integration page

Target: https://www.home-assistant.io/integrations/infrared/

Add the following section after the existing "Setting up devices that use infrared" section.

Remote adapters (infrared proxies)

The Infrared integration supports receiving infrared transmitter capabilities from ESPHome devices acting as infrared proxies. This allows you to place infrared emitters anywhere in your home, close to the appliances they need to control, without requiring a direct USB connection to your Home Assistant server.

When an ESPHome device configured as an infrared proxy is set up through the ESPHome integration, Home Assistant will automatically discover and surface the infrared transmitters it exposes. Those transmitters then appear as infrared entities and can be selected when configuring integrations for infrared-controlled devices such as TVs or air conditioners.

The following remote adapters are supported:

  • ESPHome: ESP32-based devices configured with the infrared and radio frequency proxy component

Ready-made projects

ESPHome provides ready-made firmware for infrared proxies that can be installed directly from the browser without any programming. The following devices are supported:

  • Seeed Studio XIAO IR Mate: A compact infrared emitter purpose-built for use as an infrared proxy. Available from Seeed Studio.

Tip

When placing an infrared proxy, position the device within line-of-sight of the appliance you want to control. Infrared signals do not pass through walls or other obstructions.

Related links

2. Radio Frequency integration page

Target: https://www.home-assistant.io/integrations/radio_frequency/

Add the following section after the existing "Setting up devices that use radio frequency" section.

Remote adapters (radio frequency proxies)

The Radio Frequency integration supports receiving radio frequency transmitter capabilities from ESPHome devices acting as radio frequency proxies. This lets you place radio frequency transmitters anywhere in your home to reach devices that use sub-GHz radio frequencies, such as remote outlets, garage doors, and string lights, without requiring a direct USB connection to your Home Assistant server.

When an ESPHome device configured as a radio frequency proxy is set up through the ESPHome integration, Home Assistant will automatically discover and surface the radio frequency transmitters it exposes. Those transmitters then appear as radio frequency entities and can be selected when configuring integrations for radio frequency-controlled devices.

The following remote adapters are supported:

  • ESPHome: ESP32-based devices configured with the infrared and radio frequency proxy component

Ready-made projects

ESPHome provides ready-made firmware for radio frequency proxies that can be installed directly from the browser without any programming. The following hardware combination is supported:

Note

The radio frequency proxy currently supports transmit only. The radio frequency transmitter sends commands to radio frequency-controlled devices but does not receive signals. Make sure the frequency and modulation of your radio frequency proxy hardware match what your devices expect. The M5Stack Radio Frequency Unit operates at 433 MHz, which is the most common frequency for radio frequency-controlled appliances in Europe and North America.

Related links

3. USB Discovery integration page (Serial)

Target: https://www.home-assistant.io/integrations/usb/

Add the following section after the existing "Configuration" section.

Remote adapters (serial proxies)

The USB Discovery integration supports receiving serial port capabilities from ESPHome devices acting as serial proxies. This allows integrations that require a serial connection to reach devices that are not physically co-located with your Home Assistant server, without requiring a USB cable or USB-over-IP solution.

When an ESPHome device configured as a serial proxy is set up through the ESPHome integration, Home Assistant will automatically discover and surface the serial ports it exposes. Those ports can then be selected by integrations that require a serial connection, in the same way a locally attached USB serial adapter would be.

The following remote adapters are supported:

  • ESPHome: ESP32-based devices configured with the serial proxy component

Supported port types

ESPHome serial proxies support three electrical port types, configured per UART on the device:

  • TTL: Standard logic-level serial, typically used for direct connections to microcontrollers and serial devices.
  • RS-232: Standard PC-style serial, typically used with DB9-type connectors.
  • RS-485: Differential serial bus, typically used for industrial and multi-drop networks.

Related links


Notes for implementation

  • The section headings "Remote adapters (infrared proxies)", "Remote adapters (radio frequency proxies)", and "Remote adapters (serial proxies)" mirror the Bluetooth pattern ("Remote adapters (Bluetooth proxies)") while being specific to each protocol. If the team prefers a fully consistent heading across all protocols, "Remote adapters (proxying devices)" from issue Add documentation for proxying connectivity options #188 is also workable, but the protocol-specific names are clearer for users landing on each page.
  • Both infrared and radio frequency sections link to the same ESPHome projects page (?type=ir) since they share the same project category there. If ESPHome introduces separate URL parameters in future, those links should be updated accordingly.
  • The Serial section links directly to the ESPHome serial proxy component page rather than the ready-made projects page, since no ready-made serial proxy firmware currently exists. The section should be revisited once ready-made projects are available.
  • The "Tip", "Note", and "Supported port types" callouts follow HA docs conventions and match the style used on the Bluetooth page.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Building

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions