You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: add device_info to User sensor, update README for v0.4.4
- PocketSmithUserSensor now defines device_info so it appears under
the PocketSmith device like all other entities
- Per-category sensor docs updated to reflect monthly scoping
- Attribute descriptions updated for budgeted, actual, remaining,
over_by, percentage_used
- Added transaction_count attribute to docs
- Over budget binary sensor description updated
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
13
13
- Live balance sensors for every account linked to your PocketSmith profile
14
14
- A net worth sensor summing all account balances
15
-
- Per-category spending sensors with budget vs. actual tracking
15
+
- Per-category spending sensors with monthly budget vs. actual tracking (pro-rated for non-bill categories, event-based for bill categories)
16
16
- Uncategorised transaction count so nothing slips through the cracks
17
17
- Binary sensors that alert you when you are over budget or have uncategorised transactions
18
18
- A user profile sensor with account metadata
@@ -167,12 +167,12 @@ Reports the total number of spending/income categories (excluding transfer categ
167
167
168
168
### Per-category sensors
169
169
170
-
One sensor is created for each non-transfer category in your PocketSmith account, enriched with budget data for the current period.
170
+
One sensor is created for each non-transfer category in your PocketSmith account, enriched with budget data scoped to the current calendar month.
171
171
172
172
| Property | Value |
173
173
|---|---|
174
174
| Entity ID pattern |`sensor.<category_name>`|
175
-
| State | Actual spend in the current period (numeric, `0` if no data) |
175
+
| State | Actual spend for the current calendar month (numeric, `0` if no data) |
176
176
| Unit | Category currency code |
177
177
| Icon |`mdi:cash-check` (on budget) / `mdi:cash-remove` (over budget) |
178
178
@@ -185,12 +185,13 @@ One sensor is created for each non-transfer category in your PocketSmith account
185
185
|`parent_id`| Parent category ID (if nested) |
186
186
|`parent_title`| Parent category name (if nested) |
187
187
|`is_bill`|`true` if marked as a bill in PocketSmith |
188
-
|`budgeted`| Budgeted amount for the current period |
189
-
|`actual`| Actual spend for the current period|
190
-
|`remaining`| Amount remaining under budget (`under_by`) |
191
-
|`over_by`| Amount over budget (if applicable) |
188
+
|`budgeted`| Budgeted amount for the current month. For non-bill categories this is pro-rated from the budget period to the calendar month. For bill categories this is the sum of bills scheduled this month.|
189
+
|`actual`| Actual spend from transactions this calendar month (`0` if no transactions)|
190
+
|`remaining`| Amount remaining under budget (`0` if over budget) |
191
+
|`over_by`| Amount over budget (`0`if under budget) |
192
192
|`over_budget`|`true` / `false`|
193
-
|`percentage_used`| Percentage of budget consumed |
193
+
|`percentage_used`| Percentage of budget consumed (rounded to 2 decimal places) |
194
+
|`transaction_count`| Number of transactions in this category for the current month |
194
195
|`currency`| Currency code |
195
196
196
197
---
@@ -213,7 +214,7 @@ Reports the authenticated user's display name and exposes profile metadata as at
213
214
214
215
### Pocketsmith Over Budget
215
216
216
-
Turns **on** (problem) when one or more non-transfer budget categories have exceeded their budget in the current period.
217
+
Turns **on** (problem) when one or more non-transfer budget categories have exceeded their monthly budget.
0 commit comments