Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use Thread BR extended address in WS API calls #21172

Merged
merged 7 commits into from
Jul 17, 2024
Merged

Use Thread BR extended address in WS API calls #21172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9a63030
Use extended address in WS API calls
agners Jun 26, 2024
bda9819
Fix lint error
agners Jun 26, 2024
be7956c
Update src/panels/config/integrations/integration-panels/thread/threa…
agners Jun 26, 2024
251adac
Update src/panels/config/integrations/integration-panels/thread/threa…
agners Jun 26, 2024
c477569
Use Record type to map OBTR data
agners Jun 27, 2024
db091aa
Add labels to Thread network operation icons
agners Jun 27, 2024
881e762
Apply suggestions from code review
agners Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/data/otbr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,44 @@ export interface OTBRInfo {
border_agent_id: string;
channel: number;
extended_address: string;
extended_pan_id: string;
url: string;
}

export const getOTBRInfo = (hass: HomeAssistant): Promise<OTBRInfo> =>
export type OTBRInfoDict = Record<string, OTBRInfo>;

export const getOTBRInfo = (hass: HomeAssistant): Promise<OTBRInfoDict> =>
hass.callWS({
type: "otbr/info",
});

export const OTBRCreateNetwork = (hass: HomeAssistant): Promise<void> =>
export const OTBRCreateNetwork = (
hass: HomeAssistant,
extended_address: string
): Promise<void> =>
hass.callWS({
type: "otbr/create_network",
extended_address,
});

export const OTBRSetNetwork = (
hass: HomeAssistant,
extended_address: string,
dataset_id: string
): Promise<void> =>
hass.callWS({
type: "otbr/set_network",
extended_address,
dataset_id,
});

export const OTBRSetChannel = (
hass: HomeAssistant,
extended_address: string,
channel: number
): Promise<{ delay: number }> =>
hass.callWS({
type: "otbr/set_channel",
extended_address,
channel,
});
88 changes: 56 additions & 32 deletions src/panels/config/integrations/integration-panels/thread/thread-config-panel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { getConfigEntryDiagnosticsDownloadUrl } from "../../../../../data/diagno
import {
OTBRCreateNetwork,
OTBRInfo,
OTBRInfoDict,
agners marked this conversation as resolved.
Show resolved Hide resolved
OTBRSetChannel,
OTBRSetNetwork,
getOTBRInfo,
Expand Down Expand Up @@ -75,7 +76,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {

@state() private _datasets: ThreadDataSet[] = [];

@state() private _otbrInfo?: OTBRInfo;
@state() private _otbrInfo?: OTBRInfoDict;

protected render(): TemplateResult {
const networks = this._groupRoutersByNetwork(this._routers, this._datasets);
Expand Down Expand Up @@ -160,25 +161,36 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
}

private _renderNetwork(network: ThreadNetwork) {
const otbrForNetwork =
this._otbrInfo &&
network.dataset &&
((network.dataset.preferred_extended_address &&
this._otbrInfo[network.dataset.preferred_extended_address]) ||
Object.values(this._otbrInfo).find(
(otbr) => otbr.extended_pan_id === network.dataset!.extended_pan_id
));
agners marked this conversation as resolved.
Show resolved Hide resolved
const canImportKeychain =
this.hass.auth.external?.config.canTransferThreadCredentialsToKeychain &&
network.dataset?.extended_pan_id &&
this._otbrInfo &&
this._otbrInfo?.active_dataset_tlvs?.includes(
network.dataset.extended_pan_id
);
otbrForNetwork;

return html`<ha-card>
<div class="card-header">
${network.name}${network.dataset
? html`<div>
<ha-icon-button
.label=${this.hass.localize(
"ui.panel.config.thread.thread_network_info"
)}
.otbr=${otbrForNetwork}
.network=${network}
.path=${mdiInformationOutline}
@click=${this._showDatasetInfo}
steverep marked this conversation as resolved.
Show resolved Hide resolved
></ha-icon-button
>${!network.dataset.preferred && !network.routers?.length
? html`<ha-icon-button
.label=${this.hass.localize(
"ui.panel.config.thread.thread_network_delete_credentials"
)}
.networkDataset=${network.dataset}
.path=${mdiDeleteOutline}
@click=${this._removeDataset}
Expand All @@ -196,9 +208,10 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
</h4>
</div>
${network.routers.map((router) => {
const otbr =
this._otbrInfo && this._otbrInfo[router.extended_address];
const showOverflow =
("dataset" in network && router.border_agent_id) ||
router.extended_address === this._otbrInfo?.extended_address;
("dataset" in network && router.border_agent_id) || otbr;
return html`<ha-list-item
class="router"
twoline
Expand Down Expand Up @@ -238,6 +251,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
slot="meta"
.network=${network}
.router=${router}
.otbr=${otbr}
@action=${this._handleRouterAction}
>
<ha-icon-button
Expand All @@ -262,8 +276,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
)}
</ha-list-item>`
: ""}
${router.extended_address ===
this._otbrInfo?.extended_address
${otbr
? html`<ha-list-item>
${this.hass.localize(
"ui.panel.config.thread.reset_border_router"
Expand All @@ -288,14 +301,13 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
})}`
: html`<div class="card-content no-routers">
<ha-svg-icon .path=${mdiDevices}></ha-svg-icon>
${network.dataset?.extended_pan_id &&
this._otbrInfo?.active_dataset_tlvs?.includes(
network.dataset.extended_pan_id
)
${otbrForNetwork
? html`${this.hass.localize(
"ui.panel.config.thread.no_routers_otbr_network"
)}
<mwc-button @click=${this._resetBorderRouter}
<mwc-button
.otbr=${otbrForNetwork}
@click=${this._resetBorderRouterEvent}
>${this.hass.localize(
"ui.panel.config.thread.reset_border_router"
)}</mwc-button
Expand All @@ -313,31 +325,33 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
: ""}
${canImportKeychain
? html`<div class="card-actions">
<mwc-button @click=${this._sendCredentials}
<mwc-button .otbr=${otbrForNetwork} @click=${this._sendCredentials}
>Send credentials to phone</mwc-button
>
</div>`
: ""}
</ha-card>`;
}

private _sendCredentials() {
if (!this._otbrInfo) {
private _sendCredentials(ev) {
const otbr = (ev.currentTarget as any).otbr as OTBRInfo;
if (!otbr) {
return;
}
this.hass.auth.external!.fireMessage({
type: "thread/store_in_platform_keychain",
payload: {
mac_extended_address: this._otbrInfo.extended_address,
border_agent_id: this._otbrInfo.border_agent_id ?? "",
active_operational_dataset: this._otbrInfo.active_dataset_tlvs ?? "",
mac_extended_address: otbr.extended_address,
border_agent_id: otbr.border_agent_id ?? "",
active_operational_dataset: otbr.active_dataset_tlvs ?? "",
agners marked this conversation as resolved.
Show resolved Hide resolved
},
});
}

private async _showDatasetInfo(ev: Event) {
const network = (ev.currentTarget as any).network as ThreadNetwork;
showThreadDatasetDialog(this, { network, otbrInfo: this._otbrInfo });
const otbr = (ev.currentTarget as any).otbr as OTBRInfo;
showThreadDatasetDialog(this, { network, otbrInfo: otbr });
agners marked this conversation as resolved.
Show resolved Hide resolved
}

private _importExternalThreadCredentials() {
Expand Down Expand Up @@ -454,6 +468,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
private _handleRouterAction(ev: CustomEvent<ActionDetail>) {
const network = (ev.currentTarget as any).network as ThreadNetwork;
const router = (ev.currentTarget as any).router as ThreadRouter;
const otbr = (ev.currentTarget as any).otbr as OTBRInfo;
agners marked this conversation as resolved.
Show resolved Hide resolved
const index =
network.dataset && router.border_agent_id
? Number(ev.detail.index)
Expand All @@ -463,18 +478,23 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
this._setPreferredBorderAgent(network.dataset!, router);
break;
case 1:
this._resetBorderRouter();
this._resetBorderRouter(otbr);
break;
case 2:
this._changeChannel();
this._changeChannel(otbr);
break;
case 3:
this._setDataset();
this._setDataset(otbr);
break;
}
}

private async _resetBorderRouter() {
private _resetBorderRouterEvent(ev) {
const otbr = (ev.currentTarget as any).otbr as OTBRInfo;
agners marked this conversation as resolved.
Show resolved Hide resolved
this._resetBorderRouter(otbr);
}

private async _resetBorderRouter(otbr: OTBRInfo) {
agners marked this conversation as resolved.
Show resolved Hide resolved
const confirm = await showConfirmationDialog(this, {
title: this.hass.localize(
"ui.panel.config.thread.confirm_reset_border_router"
Expand All @@ -487,7 +507,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
return;
}
try {
await OTBRCreateNetwork(this.hass);
await OTBRCreateNetwork(this.hass, otbr.extended_address);
} catch (err: any) {
showAlertDialog(this, {
title: this.hass.localize("ui.panel.config.thread.otbr_config_failed"),
Expand All @@ -497,7 +517,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
this._refresh();
}

private async _setDataset() {
private async _setDataset(otbr: OTBRInfo) {
const networks = this._groupRoutersByNetwork(this._routers, this._datasets);
const preferedDatasetId = networks.preferred?.dataset?.dataset_id;
if (!preferedDatasetId) {
Expand All @@ -515,7 +535,7 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
return;
}
try {
await OTBRSetNetwork(this.hass, preferedDatasetId);
await OTBRSetNetwork(this.hass, otbr.extended_address, preferedDatasetId);
} catch (err: any) {
showAlertDialog(this, {
title: this.hass.localize("ui.panel.config.thread.otbr_config_failed"),
Expand Down Expand Up @@ -595,8 +615,8 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
this._refresh();
}

private async _changeChannel() {
const currentChannel = this._otbrInfo?.channel;
private async _changeChannel(otbr: OTBRInfo) {
const currentChannel = otbr.channel;
const channelStr = await showPromptDialog(this, {
title: this.hass.localize("ui.panel.config.thread.change_channel"),
text: this.hass.localize("ui.panel.config.thread.change_channel_text"),
Expand All @@ -623,7 +643,11 @@ export class ThreadConfigPanel extends SubscribeMixin(LitElement) {
return;
}
try {
const result = await OTBRSetChannel(this.hass, channel);
const result = await OTBRSetChannel(
this.hass,
otbr.extended_address,
channel
);
showAlertDialog(this, {
title: this.hass.localize(
"ui.panel.config.thread.change_channel_initiated_title"
Expand Down
4 changes: 3 additions & 1 deletion src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4550,7 +4550,9 @@
"change_channel_multiprotocol_enabled_title": "The Thread radio has multiprotocol enabled",
"change_channel_multiprotocol_enabled_text": "To change channel when the Thread radio has multiprotocol enabled, please use the hardware settings menu.",
"change_channel_range": "Channel must be in the range 11 to 26",
"change_channel_text": "Initiating a channel change for your Home Assistant Thread network should be performed with caution. Some Thread devices may not migrate to the new channel automatically and, if the new channel is congested, your Thread devices may become intermittently unavailable. Some devices may need to be manually re-joined to your Thread network before they show in Home Assistant again. This action cannot be reversed (without performing another channel change)."
"change_channel_text": "Initiating a channel change for your Home Assistant Thread network should be performed with caution. Some Thread devices may not migrate to the new channel automatically and, if the new channel is congested, your Thread devices may become intermittently unavailable. Some devices may need to be manually re-joined to your Thread network before they show in Home Assistant again. This action cannot be reversed (without performing another channel change).",
"thread_network_info": "Thread network information",
"thread_network_delete_credentials": "Delete Thread network credentials"
},
"zha": {
"common": {
Expand Down
Loading