Skip to content

Commit

Permalink
docs: Updated docs (15 minutes dev time)
Browse files Browse the repository at this point in the history
  • Loading branch information
BottlecapDave committed Jan 24, 2025
1 parent 3ac9d63 commit f3e01a3
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 27 deletions.
4 changes: 4 additions & 0 deletions _docs/entities/heat_pump.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,7 @@ This represents the current outdoor temperature as observed by the heat pump.

!!! note
As the integration uses cloud polling this will inherently have a delay.

## Services

There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md#heat-pump).
4 changes: 2 additions & 2 deletions _docs/entities/octoplus.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Each available event item will include the following attributes
| Attribute | Type | Description |
|-----------|------|-------------|
| `id` | `integer` | The id of the event |
| `code` | `string` | The event code of the event. This will be required to join via the [join service](../services.md) |
| `code` | `string` | The event code of the event. This will be required to join via the [join service](../services.md#octopus_energyjoin_octoplus_saving_session_event) |
| `start` | `datetime` | The date/time the event starts |
| `end` | `datetime` | The date/time the event starts |
| `duration_in_minutes` | `integer` | The duration of the event in minutes |
Expand Down Expand Up @@ -208,5 +208,5 @@ Each item within `baselines` consists of the following attributes

## Services

There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md).
There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md#octoplus).

2 changes: 1 addition & 1 deletion _docs/entities/wheel_of_fortune.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ The number of spins remaining for gas supply

## Services

There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md).
There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md#wheel-of-fortune).
2 changes: 1 addition & 1 deletion _docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Each available event item will include the following attributes
| Attribute | Type | Description |
|-----------|------|-------------|
| `id` | `integer` | The id of the event |
| `code` | `string` | The event code of the event. This will be required to join via the [join service](./services.md) |
| `code` | `string` | The event code of the event. This will be required to join via the [join service](./services.md#octopus_energyjoin_octoplus_saving_session_event) |
| `start` | `datetime` | The date/time the event starts |
| `end` | `datetime` | The date/time the event starts |
| `duration_in_minutes` | `integer` | The duration of the event in minutes |
Expand Down
58 changes: 39 additions & 19 deletions _docs/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,41 +150,43 @@ Service for joining a new saving session event. When used, it may take a couple

For an automation example, please refer to the available [blueprint](./blueprints.md#automatically-join-saving-sessions).

### octopus_energy.spin_wheel_of_fortune

This service allows the user to perform a spin on the [wheel of fortune](./entities/wheel_of_fortune.md) that is awarded to users every month. No point letting them go to waste :)
### octopus_energy.redeem_octoplus_points_into_account_credit

!!! warning
Allows you to redeem a certain number of of Octoplus points and convert them into account credit.

Due to an ongoing issue with the underlying API, this will not award octopoints if used. If you are on Octoplus, it is advised not to use this service.
!!! info
This service is only available if you have signed up to Octoplus

| Attribute | Optional | Description |
| ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `target.entity_id` | `no` | The name of the wheel of fortune sensor that represents the type of spin to be made. This should always point at one of the [wheel of fortune sensors](./entities/wheel_of_fortune.md) entities. |
| `target.entity_id` | `no` | The name of the Octoplus points that hold the points to be redeemed. This should always point at one of the [octoplus points sensor](./entities/octoplus.md#octoplus-points) entities. |
| `data.points_to_redeem` | `no` | The number of points to redeem. |

#### Automation Example

For automation examples, please refer to the available [blueprints](./blueprints.md#wheel-of-fortune).
For automation examples, please refer to the available [blueprints](./blueprints.md#automatically-redeem-octoplus-points-for-account-credit).

## Cost Trackers
## Wheel of fortune

### octopus_energy.redeem_octoplus_points_into_account_credit
### octopus_energy.spin_wheel_of_fortune

Allows you to redeem a certain number of of Octoplus points and convert them into account credit.
This service allows the user to perform a spin on the [wheel of fortune](./entities/wheel_of_fortune.md) that is awarded to users every month. No point letting them go to waste :)

!!! info
This service is only available if you have signed up to Octoplus
!!! warning

Due to an ongoing issue with the underlying API, this will not award octopoints if used. If you are on Octoplus, it is advised not to use this service.

| Attribute | Optional | Description |
| ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `target.entity_id` | `no` | The name of the Octoplus points that hold the points to be redeemed. This should always point at one of the [octoplus points sensor](./entities/octoplus.md#octoplus-points) entities. |
| `data.points_to_redeem` | `no` | The number of points to redeem. |
| `target.entity_id` | `no` | The name of the wheel of fortune sensor that represents the type of spin to be made. This should always point at one of the [wheel of fortune sensors](./entities/wheel_of_fortune.md) entities. |

### Automation Example
#### Automation Example

For automation examples, please refer to the available [blueprints](./blueprints.md#automatically-redeem-octoplus-points-for-account-credit).
For automation examples, please refer to the available [blueprints](./blueprints.md#wheel-of-fortune).

## Cost Trackers

## octopus_energy.update_cost_tracker
### octopus_energy.update_cost_tracker

This service allows the user to turn the tracking on/off for a given [cost tracker](./setup/cost_tracker.md) sensor.

Expand All @@ -193,7 +195,7 @@ This service allows the user to turn the tracking on/off for a given [cost track
| `target.entity_id` | `no` | The name of the cost tracker sensor(s) whose configuration is to be updated. |
| `data.is_tracking_enabled` | `no` | Determines if tracking should be enabled (true) or disabled (false) for the specified cost trackers |

### Automation Example
#### Automation Example

For automation examples, please refer to the available [blueprints](./blueprints.md#cost-tracker).

Expand Down Expand Up @@ -258,7 +260,25 @@ Allows you to set the heat pump configuration for fixed and weather compensated
| `data.weather_comp_max_temperature` | `no` | Maximum allowable temperature for weather compensation, typically no higher than 70. |
| `data.fixed_flow_temperature` | `no` | If a fixed flow temperature is enabled this value will be used, typically between 30 and 70. |

## Misc
## Intelligent

### octopus_energy.refresh_intelligent_dispatches

Refreshes intelligent dispatches for a given account.

!!! info

This service is only available if you have switched to manual polling in your configuration.

!!! warning

This service can only be called a maximum of 20 times per hour.

| Attribute | Optional | Description |
| ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `target.entity_id` | `no` | The [dispatching](./entities/intelligent.md#is-dispatching) entity that you want to refresh the content for (e.g. `binary_sensor.octopus_energy_{{ACCOUNT_ID}}_intelligent_dispatching`). |

## Miscellaneous

### octopus_energy.purge_invalid_external_statistic_ids

Expand Down
2 changes: 1 addition & 1 deletion _docs/setup/cost_tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,4 @@ This is the total cost of the tracked entity for the current month during peak h

## Services

There are services available associated with cost tracker sensors. Please review them in the [services doc](../services.md#octopus_energyupdate_cost_tracker).
There are services available associated with cost tracker sensors. Please review them in the [services doc](../services.md#cost-trackers).
2 changes: 1 addition & 1 deletion _docs/setup/rolling_target_rate.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ The following attributes are available on each sensor

## Services

There are services available associated with target rate sensors. Please review them in the [services doc](../services.md).
There are services available associated with target rate sensors. Please review them in the [services doc](../services.md#rolling-target-rates).
2 changes: 1 addition & 1 deletion _docs/setup/target_rate.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ The following attributes are available on each sensor

## Services

There are services available associated with target rate sensors. Please review them in the [services doc](../services.md).
There are services available associated with target rate sensors. Please review them in the [services doc](../services.md#target-rates).

## Examples

Expand Down
3 changes: 2 additions & 1 deletion custom_components/octopus_energy/icons.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"adjust_cost_tracker": "mdi:numeric",
"redeem_octoplus_points_into_account_credit": "mdi:currency-gbp",
"boost_heat_pump_zone": "mdi:thermometer-plus",
"set_heat_pump_flow_temp_config": "mdi:heat-pump"
"set_heat_pump_flow_temp_config": "mdi:heat-pump",
"refresh_intelligent_dispatches": "mdi:refresh"
}
}

0 comments on commit f3e01a3

Please sign in to comment.