34 Commits

Author SHA1 Message Date
Andrew Grimberg
c9b9dbec8d Docs: Add trim, buffer, diagnostics
Document three recently shipped features in
README:
- Slot name trimming (spec 008)
- Lock code buffer times (spec 009)
- Keymaster event diagnostics (PR #526)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2026-05-17 16:03:27 -07:00
Andrew Grimberg
64f87c6a08 Merge pull request #484 from tykeal/feat/dynamic-description-attrs
Feat(sensor): dynamic description attributes

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2026-04-18 07:03:05 -07:00
Andrew Grimberg
69852ce14d Docs(readme): document all integration features
Add documentation for check-in tracking sensor,
keymaster monitoring switch, early checkout expiry,
manual checkout action, HA events, cleaning window,
slot dedup, retry escalation, and fetch resilience.
Rewrite existing content to fix write-good issues.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2026-03-27 16:00:34 -07:00
Andrew Grimberg
972a9b7410 Docs: add development and testing section to README
Document how to run tests, use pytest markers (unit/integration),
test directory structure, and pre-commit hook requirements.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2026-03-08 22:49:19 -07:00
Andrew Grimberg
e492cf8db8 Chore: Update pre-commit hooks
github.com/astral-sh/ruff-pre-commit: v0.8.1 -> v0.9.3 (frozen)
github.com/pre-commit/mirrors-mypy: v1.13.0 -> v1.14.1 (frozen)
github.com/rhysd/actionlint: v1.7.4 -> v1.7.7 (frozen)

* Update README.md and info.md to reflect changes from current prettier

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2025-01-26 11:47:12 -08:00
Andrew Grimberg
f94c68ec4d Docs: Fix automation bug in README.md and info.md
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-12-01 07:24:09 -08:00
Andrew Grimberg
b7c0c4d28c Docs: Add automation examples to the documentation
Fixes: #229
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-12-01 07:17:11 -08:00
Andrew Grimberg
3a3f7dae06 Docs: Improve installation instructions
Fixes: #227 #228
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-12-01 06:53:28 -08:00
Andrew Grimberg
102139a515 Docs: Update date based code docs
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-11-09 12:38:23 -08:00
Andrew Grimberg
2082ef4b21 Docs: Update documentation for short events
This updates the documentation to reflect the changes in the code that
allow for short events to be used as maintenance events.

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-06-15 13:02:43 -07:00
Andrew Grimberg
a05677c01a Chore: Add SPDX headers to all files
Configure SPDX headers in all files along with adding the needed license
text.

Configure the reuse tool to validate all license and copyright headers
exist and are correct.

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-05-18 10:54:53 -07:00
Andrew Grimberg
1d1a5fbb51 Docs: Add custom calendar FAQ and ToC
* Add a ToC to the README and info.md
* Add a FAQ section for custom calendars to the README and info.md

Issue: Fixes: #176
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-05-14 15:19:55 -07:00
Andrew Grimberg
9e46e1cccf Docs: True up info.md with README.md
Bring new documentation from README.md to the info.md which is shown by
HACS. Also cleanup line wrapping in the README.md file.

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-05-14 13:55:35 -07:00
Joe Stump
75acd0f385 Docs: Add FAQ
This is a re-implementation of PR #187 to pass tests.

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2024-05-14 13:42:46 -07:00
Andrew Grimberg
c56bd9965f Docs: Update the documentation
* Detail how custom calendar events should be constructed
* Remove information about the removed mapping sensor

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2023-09-29 10:14:59 -07:00
Andrew Grimberg
57fa71be10 Fix: Make last 4 digit check more lenient
The documentation and regex for getting door codes that are the last 4
digits of a phone number are to be made more clear and lenient.

Issue: Fixes #141
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-11-09 08:22:41 -08:00
Andrew Grimberg
8a9dc7ab72 Docs: Update docs with new code length information
Issue: Fixes #117
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-10-03 14:32:25 -07:00
Andrew Grimberg
d6d2bf704f Docs: Update README and info files
Update the README and info files with information about Keymaster
configuration and management

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-06-29 12:10:05 -07:00
Andrew Grimberg
4105b5b6dc Feat: Extract useful information from event info
There is useful information that can be extracted from event
descriptions. Since the various platforms all have different information
that may (or may not even) be available this all needs to be parsed and
handled specially.

Extracted information is attached to the event sensor if it is
available.

Issue: #94
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-05-11 10:31:44 -07:00
Andrew Grimberg
8e0bbd75fb Docs: Document code generator options
Issue: #38
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-03-20 14:56:33 -07:00
Andrew Grimberg
363d40eb68 Docs: Document configurable calendar refresh rates
Issue: #79
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-03-18 10:04:16 -07:00
Andrew Grimberg
f8478338f9 Docs: Update HACS install
With the integration now available as part of the default HACS
integrations, the installation needs to be udpated.

Issue: #69
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-01-28 09:16:26 -08:00
Andrew Grimberg
4a4e3ae617 Fix: Correct bad URLs in docs
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-01-22 12:46:27 -08:00
Andrew Grimberg
0f5d14c1b6 Docs: Improve documentation
Improve both the README and info files so that they are internally
consistent and have the appropriate information in them.

Issue: #50
Issue: #58
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-01-22 12:26:22 -08:00
Andrew Grimberg
02ec395e63 Feat: Allow integration to work without Keymaster
There has been a request to allow the integration to not depend on
Keymaster. As we are not requiring a lock to actually be used, this
makes sense.

However, we will lose functionality that is planned for the future
related to modifying checkin/checkout times of individual events if
there is no door code slot available as the intent is to inform the
integration of changes by way of modification to the in/out times of the
assigned door code.

Issue: #45
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-01-20 10:32:03 -08:00
Andrew Grimberg
700201a962 Docs: Add statement about Keymaster dependency
Keymaster is currently a hard dependency and as such, should be stated
in the documentation.

Issue: #30
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2022-01-17 08:42:54 -08:00
Andrew Grimberg
f0e6ebd272 Docs: Add pre-commit.ci badge
Add a badge for display to show status of pre-commit.ci validation

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2021-07-26 06:21:27 -07:00
Andrew Grimberg
00ca6f7056 Refactor: Fork of ical-sensor
Start from https://github.com/tybritten/ical-sensor-homeassistant/ and
refactor it into rental control.

The upstream repository is fine for basic calendar work, but given the
intended nature of this integration it's not going to be appropriate to
be pushing the changes back upstream!

Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
2021-07-25 15:47:31 -07:00
Olen
2eb0cb6f70 Merge my version (#35)
* Adding RRULES for repeating events

* Updated version

* Version bump

* Adding lots of loggingfor RRULES

* More debug

* Trying even harder to get the timezones correct

* Fixed RRULEs

* Another go at fixing recurring events, and moving some code around

* Ignoring all day events that ended at midnight today

* Complete rewrite. Use config_flow and better handling of timezones and daylight savings time

* Add extra files for config flow and calendar entity

* Update readme

* Add warning to readme

Co-authored-by: Tyler Britten <1933680+tybritten@users.noreply.github.com>
2021-01-15 11:17:12 -05:00
Bas Schipper
f66d4f7ae8 Added HACS compatibility 2019-07-07 12:31:45 +02:00
Quentin Stafford-Fraser
c572754888 Bump version to 0.2, add files needed by homeassistant 0.92 2019-04-25 12:00:50 +01:00
Tyler Britten
54ff675266 fixed Readme link 2019-03-12 17:53:30 -04:00
Tyler Britten
d3e6b25a18 updated for custom_component updater 2019-03-12 17:47:32 -04:00
Quentin Stafford-Fraser
7572be8aa2 README file tidying and renaming. 2019-02-24 23:57:50 +00:00