Skip to content

Commit 599930f

Browse files
committed
Update README.md
1 parent 696a41f commit 599930f

1 file changed

Lines changed: 26 additions & 15 deletions

File tree

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Unfolded Circle for Home Assistant
1414

15-
Home Assistant integration for [Unfolded Circle Remote Two](https://www.unfoldedcircle.com/).
15+
Home Assistant integration for [Unfolded Circle Remote Two/3](https://www.unfoldedcircle.com/).
1616

1717
## Installation
1818

@@ -42,7 +42,7 @@ While the manual installation above seems like less steps, it's important to not
4242
There is a config flow for this integration. After installing the custom component and restarting:
4343

4444
1. You should receive a notification that a new device was discovered.
45-
2. Navigate to **Settings** -> **Devices & Services** and click Configure on the newly discovered Remote Two Device.
45+
2. Navigate to **Settings** -> **Devices & Services** and click Configure on the newly discovered Unfolded Circle Device.
4646
3. _You will now begin the configuration flow process_
4747
4. **PIN** can be found on the remote by enabling the web configurator
4848
1. Enable the web configurator by tapping in the upper right on your profile icon
@@ -65,7 +65,7 @@ There is a config flow for this integration. After installing the custom compone
6565

6666
## Usage
6767

68-
After the device is configured, the integration will expose 22 entities plus the number of activities you have defined on your remote. These are grouped by device. Four of these entities will be disabled by default. These are all diagnostic in nature and report the device stats and if polling of the remote is enabled. (This is only true if any of the three device stat entities are enabled.)
68+
After the device is configured, the integration will expose 22 entities plus the number of activities you have defined on your remote. These are grouped by device. Four of these entities will be disabled by default. These are all diagnostic in nature and report the device stats and if polling of the remote is enabled. (Polling is only true if any of the three device stat entities are enabled.)
6969

7070
- Sensors
7171
- Battery Level: Reporting current charge percentage
@@ -93,17 +93,21 @@ After the device is configured, the integration will expose 22 entities plus the
9393
- A media player entity is created providing controls and information about currently playing media. If multiple media player entities are active, the integration attempts to select the most appropriate based on activity and recency.
9494
- You can override this behavior by selecting a different media source from the sound mode menu in the Media Player control
9595
- Options exist to create a media player per activity group or per activity.
96-
- **Update** The media player controls are now mapped to the selected activity's button mapping on the remote. The default is still the active media player, but if you have defined custom volume, next, previous, or power button commands, those will be executed when interacting with the control within home assistant.
96+
- The media player controls are now mapped to the selected activity's button mapping on the remote. The default is still the active media player, but if you have defined custom volume, next, previous, or power button commands, those will be executed when interacting with the control within home assistant.
9797
- Number
98-
9998
- Configuration Controls: All numerical settings are now controllable via the integration.
10099

101100
\*\* Disabled by default to avoid polling the remote every thirty seconds to read data. If one of these sensors is enabled, polling only for that specific data will also be enabled.
102101

103102
## Dock Support
104103

105-
Dock support has now been added. If you have an existing remote configured, you will be prompted with a repair for each dock associated with your remote. You can also add docks via a configuration flow when adding a remote. Each Dock exposes 4 entities:
104+
Dock support has been reworked. Docks are now `Subentries` and can be added and removed at will. During a one time migration, any Docks you have configured and any Docks with an initial password will be added as `Subenty Devices`. To add further Docks, click the `Add Dock` button in the top right. If you have multiple `UC Remotes`, you will be prompted to select which UC remote the dock is associated with. If a single dock is associated with multiple UC remotes, you can add the dock to any amount of your configured UC remotes. If you no longer wish to have your a dock loaded in Home Assistant, it is now independantly removable. Delete it or disable it like any other deivce.
105+
106+
Each Dock exposes 6 entities:
106107

108+
- Remote
109+
- This entity represents the IR remote capabilities of the dock itself
110+
107111
- Buttons
108112

109113
- Reboot Dock: Allows you to remotely reboot the dock
@@ -112,19 +116,22 @@ Dock support has now been added. If you have an existing remote configured, you
112116
- Number
113117
- LED Brightness: Allows you to set the LED brightness level
114118
- Ethernet Brightness: Allows you to set the Ethernet LED brightness level
119+
120+
- Update
121+
- An update entity that reports the latest version
115122

116-
During a config flow, if you are unsure of your password, you can skip adding that dock for the moment by submitting the form without a password supplied. This will cause a repair to be created so you can set it at your leasure.
123+
### Additional Information
117124

118-
If you are unsure of the password you set, you can change it via the web configurator. Click on the Integrations and Dock menu and then select the dock you need to change the password for. Once changed, come back to the repair and let home assistant know what you set it to.
125+
- Docks will now be automatically setup when they have an initial password. No need to supply it (or be left with a bunch of repairs)
126+
- During the migration, any existing repairs will be deleted. You are now in charge of when a dock is added.
119127

120128
## External Entity Management
121129

122130
Home Assistant now has the ability to manage the entities it shares with your Unfolded Circle Remote. When setting up a new device or when reconfiguring an existing device, you will be taken through an optional step to configure which Home Assistant entities are available on the remote. This functionality mirrors the same options on the integrations page of your remote. If you are upgrading to this release, you will get a repair to address on first boot. Complete it to switch over to using the much improved communication method with your remote.
123131

124132
To get started, add a new device or click the configure button. See the video below for a quick demo.
125133
- You must be running v2.0.0 or greater on your unfolded circle remote for this functionality to be available.
126-
- v2.2+ is currently in beta (But it's very stable)
127-
- This release should work fine for anyone not running the remote beta, but it has only been lightly tested.
134+
- v2.6.5+ is currently in beta but it's very stable and is the only firmware for Remote 3 devices.
128135

129136
https://github.com/user-attachments/assets/96fa94e8-a5ad-4833-9a49-0bf85373eae0
130137

@@ -261,20 +268,24 @@ Your Remote will be automatically discovered on the network.
261268

262269
## Wake on lan
263270

264-
Wake on lan support is now available for remotes running firmware version 2.0.0 or higher. Once your remote has been upgraded, and you've turned the feature on, anytime you take a direct action within home assistant to communicate with the remote, it will first attempt to wake the remote up.
271+
Wake on lan support is now available for Remote Two devices running firmware version 2.0.0 or higher. Once your remote has been upgraded, and you've turned the feature on, anytime you take a direct action within home assistant to communicate with the remote, it will first attempt to wake the remote up.
272+
273+
> [!TIP]
274+
Remote 3 WOL support will be added once it is available on the device.
275+
>
265276
266277
## Future Ideas
267278

268-
- [X] Wake on lan was added by the remote developers and has been implemented
279+
- [ ] Add ability to send raw IR commands using the `remote.send_command` action
269280

270281
## Notes
271282

272283
- The remote entity does not need to be "on" for it to send commands.
273284
- The Remote Two will go to sleep when unpowered. If you have wake on lan enabled on your remote, Home Assistant will attempt to wake your remote prior to issuing a command. Only commands initiated by you will attempt to wake the remote.
274285
- The remote can now generate its own diagnostic data to aid in debugging via the overflow menu in the Device Info section
275-
- The integration supports multiple Languages: English, French
276-
- The integration will now identify a repair and prompt for a new PIN if it can no longer authenticate to the remote
286+
- The integration supports multiple Languages: English, French, Portuguese and PRs are always welcome
287+
- The integration will create a repair and prompt for a new PIN if it can no longer authenticate to the remote
277288

278289
## About This Project
279290

280-
I am now working with the Unfolded Circle staff but am not affiliated with them, and provide this custom component purely for your own enjoyment and home automation needs. Those guys are still awesome!
291+
I am collaborating with the Unfolded Circle staff but am not affiliated with them, and provide this custom component purely for your own enjoyment and home automation needs. Those guys are awesome!

0 commit comments

Comments
 (0)