Skip to content

Add ignore discovery button #4354

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

Merged
balloob merged 4 commits into from
Dec 18, 2019
Merged

Add ignore discovery button #4354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50bf886
Add ignore discovery button
bramkragten Dec 16, 2019
e175dcb
Add seperate list for ignored integrations
bramkragten Dec 17, 2019
ca9d8f5
Move translations
bramkragten Dec 18, 2019
3e76f17
Add zeroconf
bramkragten Dec 18, 2019
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
5 changes: 5 additions & 0 deletions src/data/config_flow.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { debounce } from "../common/util/debounce";
import { getCollection, Connection } from "home-assistant-js-websocket";
import { LocalizeFunc } from "../common/translations/localize";

export const DISCOVERY_SOURCES = ["homekit", "ssdp", "zeroconf"];

export const createConfigFlow = (hass: HomeAssistant, handler: string) =>
hass.callApi<DataEntryFlowStep>("POST", "config/config_entries/flow", {
handler,
Expand All @@ -26,6 +28,9 @@ export const handleConfigFlowStep = (
data
);

export const ignoreConfigFlow = (hass: HomeAssistant, flowId: string) =>
hass.callWS({ type: "config_entries/ignore_flow", flow_id: flowId });

export const deleteConfigFlow = (hass: HomeAssistant, flowId: string) =>
hass.callApi("DELETE", `config/config_entries/flow/${flowId}`);

Expand Down
233 changes: 185 additions & 48 deletions src/panels/config/integrations/ha-config-entries-dashboard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import "@polymer/iron-flex-layout/iron-flex-layout-classes";
import "@polymer/paper-tooltip/paper-tooltip";
import "@material/mwc-button";
import "@polymer/iron-icon/iron-icon";
import "@polymer/paper-listbox/paper-listbox";
import "@polymer/paper-item/paper-item";
import "@polymer/paper-item/paper-item-body";

Expand All @@ -23,7 +24,11 @@ import {
loadConfigFlowDialog,
showConfigFlowDialog,
} from "../../../dialogs/config-flow/show-dialog-config-flow";
import { localizeConfigFlowTitle } from "../../../data/config_flow";
import {
localizeConfigFlowTitle,
ignoreConfigFlow,
DISCOVERY_SOURCES,
} from "../../../data/config_flow";
import {
LitElement,
TemplateResult,
Expand All @@ -34,10 +39,11 @@ import {
CSSResult,
} from "lit-element";
import { HomeAssistant } from "../../../types";
import { ConfigEntry } from "../../../data/config_entries";
import { ConfigEntry, deleteConfigEntry } from "../../../data/config_entries";
import { fireEvent } from "../../../common/dom/fire_event";
import { EntityRegistryEntry } from "../../../data/entity_registry";
import { DataEntryFlowProgress } from "../../../data/data_entry_flow";
import { showConfirmationDialog } from "../../../dialogs/confirmation/show-dialog-confirmation";

@customElement("ha-config-entries-dashboard")
export class HaConfigManagerDashboard extends LitElement {
Expand All @@ -56,6 +62,7 @@ export class HaConfigManagerDashboard extends LitElement {
* For example, can be discovered devices that require more config.
*/
@property() private configEntriesInProgress!: DataEntryFlowProgress[];
@property() private _showIgnored = false;

public connectedCallback() {
super.connectedCallback();
Expand All @@ -67,6 +74,67 @@ export class HaConfigManagerDashboard extends LitElement {
<hass-subpage
header=${this.hass.localize("ui.panel.config.integrations.caption")}
>
<paper-menu-button
close-on-activate
no-animations
horizontal-align="right"
horizontal-offset="-5"
slot="toolbar-icon"
>
<paper-icon-button
icon="hass:dots-vertical"
slot="dropdown-trigger"
alt="menu"
></paper-icon-button>
<paper-listbox
slot="dropdown-content"
role="listbox"
selected="{{selectedItem}}"
>
<paper-item @click=${this._toggleShowIgnored}>
${this.hass.localize(
this._showIgnored
? "ui.panel.config.integrations.ignore.hide_ignored"
: "ui.panel.config.integrations.ignore.show_ignored"
)}
</paper-item>
</paper-listbox>
</paper-menu-button>

${this._showIgnored
? html`
<ha-config-section>
<span slot="header"
>${this.hass.localize(
"ui.panel.config.integrations.ignore.ignored"
)}</span
>
<ha-card>
${this.configEntries
.filter((item) => item.source === "ignore")
.map(
(item: ConfigEntry) => html`
<paper-item>
<paper-item-body>
${this.hass.localize(
`component.${item.domain}.config.title`
)}
</paper-item-body>
<paper-icon-button
@click=${this._removeIgnoredIntegration}
.entry=${item}
icon="hass:delete"
aria-label=${this.hass.localize(
"ui.panel.config.integrations.details"
)}
></paper-icon-button>
</paper-item>
`
)}
</ha-card>
</ha-config-section>
`
: ""}
${this.configEntriesInProgress.length
? html`
<ha-config-section>
Expand All @@ -82,9 +150,22 @@ export class HaConfigManagerDashboard extends LitElement {
<paper-item-body>
${localizeConfigFlowTitle(this.hass.localize, flow)}
</paper-item-body>
${DISCOVERY_SOURCES.includes(flow.context.source) &&
flow.context.unique_id
? html`
<mwc-button
@click=${this._ignoreFlow}
.flow=${flow}
>
${this.hass.localize(
"ui.panel.config.integrations.ignore.ignore"
)}
</mwc-button>
`
: ""}
<mwc-button
@click=${this._continueFlow}
data-id="${flow.flow_id}"
.flowId=${flow.flow_id}
>${this.hass.localize(
"ui.panel.config.integrations.configure"
)}</mwc-button
Expand All @@ -98,49 +179,51 @@ export class HaConfigManagerDashboard extends LitElement {
: ""}

<ha-config-section class="configured">
<span slot="header"
>${this.hass.localize(
"ui.panel.config.integrations.configured"
)}</span
>
<span slot="header">
${this.hass.localize("ui.panel.config.integrations.configured")}
</span>
<ha-card>
${this.entityRegistryEntries.length
? this.configEntries.map(
(item: any, idx) => html`
<a
href="/config/integrations/config_entry/${item.entry_id}"
>
<paper-item data-index=${idx}>
<paper-item-body two-line>
<div>
${this.hass.localize(
`component.${item.domain}.config.title`
)}:
${item.title}
</div>
<div secondary>
${this._getEntities(item).map(
(entity) => html`
<span>
<ha-state-icon
.stateObj=${entity}
></ha-state-icon>
<paper-tooltip position="bottom"
>${computeStateName(entity)}</paper-tooltip
>
</span>
`
)}
</div>
</paper-item-body>
<ha-icon-next
aria-label=${this.hass.localize(
"ui.panel.config.integrations.details"
)}
></ha-icon-next>
</paper-item>
</a>
`
? this.configEntries.map((item: any, idx) =>
item.source === "ignore"
? ""
: html`
<a
href="/config/integrations/config_entry/${item.entry_id}"
>
<paper-item data-index=${idx}>
<paper-item-body two-line>
<div>
${this.hass.localize(
`component.${item.domain}.config.title`
)}:
${item.title}
</div>
<div secondary>
${this._getEntities(item).map(
(entity) => html`
<span>
<ha-state-icon
.stateObj=${entity}
></ha-state-icon>
<paper-tooltip position="bottom"
>${computeStateName(
entity
)}</paper-tooltip
>
</span>
`
)}
</div>
</paper-item-body>
<ha-icon-next
aria-label=${this.hass.localize(
"ui.panel.config.integrations.details"
)}
></ha-icon-next>
</paper-item>
</a>
`
)
: html`
<div class="config-entry-row">
Expand Down Expand Up @@ -176,12 +259,64 @@ export class HaConfigManagerDashboard extends LitElement {

private _continueFlow(ev: Event) {
showConfigFlowDialog(this, {
continueFlowId:
(ev.target as HTMLElement).getAttribute("data-id") || undefined,
continueFlowId: (ev.target! as any).flowId,
dialogClosedCallback: () => fireEvent(this, "hass-reload-entries"),
});
}

private _ignoreFlow(ev: Event) {
const flow = (ev.target! as any).flow;
showConfirmationDialog(this, {
title: this.hass!.localize(
"ui.panel.config.integrations.ignore.confirm_ignore_title",
"name",
localizeConfigFlowTitle(this.hass.localize, flow)
),
text: this.hass!.localize(
"ui.panel.config.integrations.ignore.confirm_ignore"
),
confirmBtnText: this.hass!.localize(
"ui.panel.config.integrations.ignore.ignore"
),
confirm: () => {
ignoreConfigFlow(this.hass, flow.flow_id);
fireEvent(this, "hass-reload-entries");
},
});
}

private _toggleShowIgnored() {
this._showIgnored = !this._showIgnored;
}

private async _removeIgnoredIntegration(ev: Event) {
const entry = (ev.target! as any).entry;
showConfirmationDialog(this, {
title: this.hass!.localize(
"ui.panel.config.integrations.ignore.confirm_delete_ignore_title",
"name",
this.hass.localize(`component.${entry.domain}.config.title`)
),
text: this.hass!.localize(
"ui.panel.config.integrations.ignore.confirm_delete_ignore"
),
confirmBtnText: this.hass!.localize(
"ui.panel.config.integrations.ignore.stop_ignore"
),
confirm: async () => {
const result = await deleteConfigEntry(this.hass, entry.entry_id);
if (result.require_restart) {
alert(
this.hass.localize(
"ui.panel.config.integrations.config_entry.restart_confirm"
)
);
}
fireEvent(this, "hass-reload-entries");
},
});
}

private _getEntities(configEntry: ConfigEntry): HassEntity[] {
if (!this.entityRegistryEntries) {
return [];
Expand All @@ -203,8 +338,7 @@ export class HaConfigManagerDashboard extends LitElement {
overflow: hidden;
}
mwc-button {
top: 3px;
margin-right: -0.57em;
align-self: center;
}
.config-entry-row {
display: flex;
Expand All @@ -229,6 +363,9 @@ export class HaConfigManagerDashboard extends LitElement {
right: auto;
left: 16px;
}
.overflow {
width: 56px;
}
`;
}
}
2 changes: 1 addition & 1 deletion src/panels/config/integrations/ha-config-integrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class HaConfigIntegrations extends HassRouterPage {
private _loadData() {
getConfigEntries(this.hass).then((configEntries) => {
this._configEntries = configEntries.sort((conf1, conf2) =>
compare(conf1.title, conf2.title)
compare(conf1.domain + conf1.title, conf2.domain + conf2.title)
);
});
if (this._unsubs) {
Expand Down
11 changes: 11 additions & 0 deletions src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1307,6 +1307,17 @@
"none": "Nothing configured yet",
"integration_not_found": "Integration not found.",
"details": "Integration details",
"ignore": {
"ignore": "Ignore",
"confirm_ignore_title": "Ignore discovery of {name}?",
"confirm_ignore": "Are you sure you don't want to setup this integration? You can undo this by clicking the 'Show ignored integrations' in the overflow menu on the top right.",
"show_ignored": "Show ignored integrations",
"hide_ignored": "Hide ignored integrations",
"ignored": "Ignored",
"confirm_delete_ignore_title": "Stop ignoring {name}?",
"confirm_delete_ignore": "This will make the integration appear in your discovered integrations again when it gets discovered. This might require a restart or take some time.",
"stop_ignore": "Stop ignoring"
},
"config_entry": {
"settings_button": "Edit settings for {integration}",
"system_options_button": "System options for {integration}",
Expand Down