Skip to content

Commit

Permalink
renamed blueprint to askoheat
Browse files Browse the repository at this point in the history
  • Loading branch information
toggm committed Nov 5, 2024
1 parent 326c5f6 commit 5290b12
Show file tree
Hide file tree
Showing 24 changed files with 52 additions and 53 deletions.
2 changes: 1 addition & 1 deletion .devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ludeeus/integration_blueprint",
"name": "toggm/askoheat",
"image": "mcr.microsoft.com/devcontainers/python:3.12",
"postCreateCommand": "scripts/setup",
"forwardPorts": [
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ body:
required: true
- label: This issue only contains 1 issue (if you have multiple issues, open one issue for each issue).
required: true
- label: This issue is not a duplicate issue of any [previous issues](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Bug%22+)..
- label: This issue is not a duplicate issue of any [previous issues](https://github.com/toggm/askoheat/issues?q=is%3Aissue+label%3A%22Bug%22+)..
required: true
- type: textarea
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
required: true
- label: This only contains 1 feature request (if you have multiple feature requests, open one feature request for each feature request).
required: true
- label: This issue is not a duplicate feature request of [previous feature requests](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Feature+Request%22+).
- label: This issue is not a duplicate feature request of [previous feature requests](https://github.com/toggm/askoheat/issues?q=is%3Aissue+label%3A%22Feature+Request%22+).
required: true

- type: textarea
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ jobs:
- name: "ZIP the integration directory"
shell: "bash"
run: |
cd "${{ github.workspace }}/custom_components/integration_blueprint"
zip integration_blueprint.zip -r ./
cd "${{ github.workspace }}/custom_components/askoheat"
zip askoheat.zip -r ./
- name: "Upload the ZIP file to the release"
uses: "softprops/[email protected]"
with:
files: ${{ github.workspace }}/custom_components/integration_blueprint/integration_blueprint.zip
files: ${{ github.workspace }}/custom_components/askoheat/askoheat.zip
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Use [black](https://github.com/ambv/black) to make sure the code follows the sty

## Test your code modification

This custom component is based on [integration_blueprint template](https://github.com/ludeeus/integration_blueprint).
This custom component is based on [askoheat template](https://github.com/ludeeus/askoheat).

It comes with development environment in a container, easy to launch
if you use Visual Studio Code. With this container you will have a stand alone
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 - 2024 Joakim Sørensen @ludeeus
Copyright (c) 2025 Mike Toggweiler @toggm

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 10 additions & 12 deletions README_EXAMPLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

_Integration to integrate with [integration_blueprint][integration_blueprint]._
_Integration to integrate with [askoheat][askoheat]._

**This integration will set up the following platforms.**

Expand All @@ -24,8 +24,8 @@ Platform | Description

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
1. If you do not have a `custom_components` directory (folder) there, you need to create it.
1. In the `custom_components` directory (folder) create a new folder called `integration_blueprint`.
1. Download _all_ the files from the `custom_components/integration_blueprint/` directory (folder) in this repository.
1. In the `custom_components` directory (folder) create a new folder called `askoheat`.
1. Download _all_ the files from the `custom_components/askoheat/` directory (folder) in this repository.
1. Place the files you downloaded in the new directory (folder) you created.
1. Restart Home Assistant
1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Integration blueprint"
Expand All @@ -40,17 +40,15 @@ If you want to contribute to this please read the [Contribution guidelines](CONT

***

[integration_blueprint]: https://github.com/ludeeus/integration_blueprint
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
[askoheat]: https://github.com/toggm/askoheat
[buymecoffee]: https://www.buymeacoffee.com/toggm
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/ludeeus/integration_blueprint.svg?style=for-the-badge
[commits]: https://github.com/ludeeus/integration_blueprint/commits/main
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/toggm/askoheat.svg?style=for-the-badge
[commits]: https://github.com/ludeeus/askoheat/commits/main
[exampleimg]: example.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/ludeeus/integration_blueprint.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/toggm/askoheat.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/ludeeus/integration_blueprint.svg?style=for-the-badge
[releases]: https://github.com/ludeeus/integration_blueprint/releases
[releases-shield]: https://img.shields.io/github/release/ludeeus/askoheat.svg?style=for-the-badge
[releases]: https://github.com/ludeeus/askoheat/releases
2 changes: 1 addition & 1 deletion config/configuration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ homeassistant:
logger:
default: info
logs:
custom_components.integration_blueprint: debug
custom_components.askoheat: debug
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""
Custom integration to integrate integration_blueprint with Home Assistant.
Custom integration to integrate askoheat+ hot water heating with Home Assistant.
For more details about this integration, please refer to
https://github.com/ludeeus/integration_blueprint
https://github.com/toggm/askoheat
"""

from __future__ import annotations
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Binary sensor platform for integration_blueprint."""
"""Binary sensor platform for askoheat."""

from __future__ import annotations

Expand All @@ -21,7 +21,7 @@

ENTITY_DESCRIPTIONS = (
BinarySensorEntityDescription(
key="integration_blueprint",
key="askoheat",
name="Integration Blueprint Binary Sensor",
device_class=BinarySensorDeviceClass.CONNECTIVITY,
),
Expand All @@ -44,7 +44,7 @@ async def async_setup_entry(


class IntegrationBlueprintBinarySensor(IntegrationBlueprintEntity, BinarySensorEntity):
"""integration_blueprint binary_sensor class."""
"""askoheat binary_sensor class."""

def __init__(
self,
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""Constants for integration_blueprint."""
"""Constants for askoheat."""

from logging import Logger, getLogger

LOGGER: Logger = getLogger(__package__)

DOMAIN = "integration_blueprint"
DOMAIN = "askoheat"
ATTRIBUTION = "Data provided by http://jsonplaceholder.typicode.com/"
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""DataUpdateCoordinator for integration_blueprint."""
"""DataUpdateCoordinator for askoheat."""

from __future__ import annotations

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Custom types for integration_blueprint."""
"""Custom types for askoheat."""

from __future__ import annotations

Expand Down
File renamed without changes.
12 changes: 12 additions & 0 deletions custom_components/askoheat/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"domain": "askoheat",
"name": "Askoheat+",
"codeowners": [
"@toggm"
],
"config_flow": true,
"documentation": "https://github.com/toggm/askoheat",
"iot_class": "cloud_polling",
"issue_tracker": "https://github.com/toggm/askoheat/issues",
"version": "0.0.0"
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Sensor platform for integration_blueprint."""
"""Sensor platform for askoheat."""

from __future__ import annotations

Expand All @@ -17,7 +17,7 @@

ENTITY_DESCRIPTIONS = (
SensorEntityDescription(
key="integration_blueprint",
key="askoheat",
name="Integration Sensor",
icon="mdi:format-quote-close",
),
Expand All @@ -40,7 +40,7 @@ async def async_setup_entry(


class IntegrationBlueprintSensor(IntegrationBlueprintEntity, SensorEntity):
"""integration_blueprint Sensor class."""
"""askoheat Sensor class."""

def __init__(
self,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Switch platform for integration_blueprint."""
"""Switch platform for askoheat."""

from __future__ import annotations

Expand All @@ -17,7 +17,7 @@

ENTITY_DESCRIPTIONS = (
SwitchEntityDescription(
key="integration_blueprint",
key="askoheat",
name="Integration Switch",
icon="mdi:format-quote-close",
),
Expand All @@ -40,7 +40,7 @@ async def async_setup_entry(


class IntegrationBlueprintSwitch(IntegrationBlueprintEntity, SwitchEntity):
"""integration_blueprint switch class."""
"""askoheat switch class."""

def __init__(
self,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"config": {
"step": {
"user": {
"description": "If you need help with the configuration have a look here: https://github.com/ludeeus/integration_blueprint",
"description": "If you need help with the configuration have a look here: https://github.com/toggm/askoheat",
"data": {
"username": "Username",
"password": "Password"
Expand Down
12 changes: 0 additions & 12 deletions custom_components/integration_blueprint/manifest.json

This file was deleted.

4 changes: 2 additions & 2 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Integration blueprint",
"name": "Askoheat",
"hide_default_branch": true,
"homeassistant": "2024.6.0",
"homeassistant": "2024.10.3",
"render_readme": true
}
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
colorlog==6.8.2
homeassistant==2024.6.0
homeassistant==2024.10.3
pip>=21.3.1
ruff==0.7.1
pymodbus==3.7.4
2 changes: 1 addition & 1 deletion scripts/develop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ if [[ ! -d "${PWD}/config" ]]; then
fi

# Set the path to custom_components
## This let's us have the structure we want <root>/custom_components/integration_blueprint
## This let's us have the structure we want <root>/custom_components/askoheat
## while at the same time have Home Assistant configuration inside <root>/config
## without resulting to symlinks.
export PYTHONPATH="${PYTHONPATH}:${PWD}/custom_components"
Expand Down

0 comments on commit 5290b12

Please sign in to comment.