Skip to content

Commit dca3c51

Browse files
author
Frank Klaassen
committed
Add dedicated action pages for Peblar RFID token management
1 parent 541d913 commit dca3c51

4 files changed

Lines changed: 127 additions & 32 deletions

File tree

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "Add an RFID token"
3+
action: peblar.add_rfid_token
4+
domain: peblar
5+
description: "Adds a new RFID token to the Peblar charger's standalone authorization list."
6+
related:
7+
- docs: /integrations/peblar/
8+
title: Peblar
9+
- action: peblar.list_rfid_tokens
10+
- action: peblar.remove_rfid_token
11+
---
12+
13+
The **Add RFID token** action adds a new RFID token to the Peblar charger's standalone authorization list. Once added, the token can be used to authorize charging sessions on the charger without requiring a connection to an external backend.
14+
15+
{% include actions/try_it.md %}
16+
17+
{% include actions/yaml_header.md %}
18+
19+
In YAML, refer to this action as `peblar.add_rfid_token`. A basic example looks like this:
20+
21+
{% example %}
22+
action: |
23+
action: peblar.add_rfid_token
24+
data:
25+
config_entry_id: "01234567890abcdef01234567890abcd"
26+
uid: "04A1B2C3D4E5F6"
27+
description: "Jane's key fob"
28+
{% endexample %}
29+
30+
### Options in YAML
31+
32+
{% options_yaml %}
33+
config_entry_id:
34+
description: >
35+
The ID of the Peblar charger config entry to add the RFID token to.
36+
required: true
37+
type: string
38+
uid:
39+
description: >
40+
The unique identifier (UID) of the RFID token to add. This is typically printed on the card or key fob.
41+
required: true
42+
type: string
43+
description:
44+
description: >
45+
A human-readable label for this RFID token, for example, the name of the person it belongs to.
46+
required: true
47+
type: string
48+
{% endoptions_yaml %}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "List RFID tokens"
3+
action: peblar.list_rfid_tokens
4+
domain: peblar
5+
description: "Returns all RFID tokens currently configured in the Peblar charger's standalone authorization list."
6+
related:
7+
- docs: /integrations/peblar/
8+
title: Peblar
9+
---
10+
11+
The **List RFID tokens** action retrieves all RFID tokens stored in the Peblar charger's standalone authorization list. The action returns the full list as response data, which you can use in an automation or script to inspect or filter the tokens configured on your charger.
12+
13+
{% include actions/try_it.md %}
14+
15+
{% include actions/yaml_header.md %}
16+
17+
In YAML, refer to this action as `peblar.list_rfid_tokens`. A basic example looks like this:
18+
19+
{% example %}
20+
action: |
21+
action: peblar.list_rfid_tokens
22+
data:
23+
config_entry_id: "01234567890abcdef01234567890abcd"
24+
{% endexample %}
25+
26+
### Options in YAML
27+
28+
{% options_yaml %}
29+
config_entry_id:
30+
description: >
31+
The ID of the Peblar charger config entry to retrieve the RFID token list from.
32+
required: true
33+
type: string
34+
{% endoptions_yaml %}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Remove an RFID token"
3+
action: peblar.remove_rfid_token
4+
domain: peblar
5+
description: "Removes an RFID token from the Peblar charger's standalone authorization list."
6+
related:
7+
- docs: /integrations/peblar/
8+
title: Peblar
9+
- action: peblar.list_rfid_tokens
10+
- action: peblar.add_rfid_token
11+
---
12+
13+
The **Remove RFID token** action deletes an RFID token from the Peblar charger's standalone authorization list. Once removed, that token can no longer be used to authorize charging sessions on the charger.
14+
15+
{% include actions/try_it.md %}
16+
17+
{% include actions/yaml_header.md %}
18+
19+
In YAML, refer to this action as `peblar.remove_rfid_token`. A basic example looks like this:
20+
21+
{% example %}
22+
action: |
23+
action: peblar.remove_rfid_token
24+
data:
25+
config_entry_id: "01234567890abcdef01234567890abcd"
26+
uid: "04A1B2C3D4E5F6"
27+
{% endexample %}
28+
29+
### Options in YAML
30+
31+
{% options_yaml %}
32+
config_entry_id:
33+
description: >
34+
The ID of the Peblar charger config entry to remove the RFID token from.
35+
required: true
36+
type: string
37+
uid:
38+
description: >
39+
The unique identifier (UID) of the RFID token to remove.
40+
required: true
41+
type: string
42+
{% endoptions_yaml %}

source/_integrations/peblar.markdown

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -233,38 +233,9 @@ instantly.
233233

234234
The Peblar integration provides the following actions to manage the RFID tokens in the charger's standalone authorization list.
235235

236-
### Action: List RFID tokens
237-
238-
The `peblar.list_rfid_tokens` action returns all RFID tokens currently configured in the charger's standalone authorization list.
239-
240-
- **Data attribute**: `config_entry_id`
241-
- **Description**: The Peblar charger to retrieve the RFID token list from.
242-
- **Optional**: No
243-
244-
### Action: Add RFID token
245-
246-
The `peblar.add_rfid_token` action adds a new RFID token to the charger's standalone authorization list.
247-
248-
- **Data attribute**: `config_entry_id`
249-
- **Description**: The Peblar charger to add the RFID token to.
250-
- **Optional**: No
251-
- **Data attribute**: `uid`
252-
- **Description**: The unique identifier (UID) of the RFID token to add.
253-
- **Optional**: No
254-
- **Data attribute**: `description`
255-
- **Description**: A human-readable label for this RFID token, for example, the name of the person it belongs to.
256-
- **Optional**: No
257-
258-
### Action: Remove RFID token
259-
260-
The `peblar.remove_rfid_token` action removes an RFID token from the charger's standalone authorization list.
261-
262-
- **Data attribute**: `config_entry_id`
263-
- **Description**: The Peblar charger to remove the RFID token from.
264-
- **Optional**: No
265-
- **Data attribute**: `uid`
266-
- **Description**: The unique identifier (UID) of the RFID token to remove.
267-
- **Optional**: No
236+
- [List RFID tokens](/actions/peblar.list_rfid_tokens/) — returns all RFID tokens currently configured on the charger.
237+
- [Add RFID token](/actions/peblar.add_rfid_token/) — adds a new RFID token using a UID and description.
238+
- [Remove RFID token](/actions/peblar.remove_rfid_token/) — removes an RFID token by its UID.
268239

269240
## Examples
270241

0 commit comments

Comments
 (0)