Skip to content

Commit b84f84d

Browse files
committed
Add changelog
1 parent f505139 commit b84f84d

File tree

2 files changed

+163
-0
lines changed

2 files changed

+163
-0
lines changed

.markdownlint.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
default: true
22
MD013: false
3+
MD024: false

CHANGELOG.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.2.2] - 2025-08-02
9+
10+
### Changed
11+
12+
- Fixed callback function to async
13+
- Added a method to control provisioning mode for AirOS devices.
14+
- Introduced a high-level asynchronous device discovery function for AirOS devices.
15+
- Standardized class, exception, and log naming from "Airos" to "AirOS" across the codebase.
16+
- Renamed enum members in WirelessMode for improved clarity.
17+
- Updated tests and fixtures to use new naming conventions and to cover new discovery functionality.
18+
19+
## [0.2.1] - 2025-08-02
20+
21+
### Added
22+
23+
- Added a new field to device status data showing the MAC address and interface name of the primary enabled interface.
24+
25+
### Changed
26+
27+
- Updated wireless fixture data to reflect the correct access point MAC address.
28+
29+
## [0.2.0] - 2025-07-28
30+
31+
### Added
32+
33+
- Added UDP-based discovery for Ubiquiti airOS devices, enabling automatic detection and information retrieval from devices on the network.
34+
- Introduced detailed error handling and new exception types for discovery-related issues.
35+
- Improved code consistency by standardizing logger variable naming.
36+
- Added a script to generate mock discovery packet fixtures for testing.
37+
- Introduced comprehensive tests for the new device discovery functionality.
38+
39+
## [0.1.8] - 2025-07-28
40+
41+
### Added
42+
43+
- Improved device connection status reporting with clearer distinction between connected and disconnected devices.
44+
- Enhanced status information for UNMS connectivity.
45+
- Clarified descriptions for connected and disconnected device states.
46+
47+
## [0.1.7] - 2025-07-27
48+
49+
### Changed
50+
51+
- Improved login error handling by providing a clear error message when authentication is denied.
52+
53+
## [0.1.6] - 2025-07-26
54+
55+
### Changed
56+
57+
- Renamed the AirOS data class to clarify its association with AirOS v8 devices.
58+
- Updated documentation to specify support for AirOS v8 devices.
59+
- Adjusted import statements to reflect the class renaming.
60+
61+
## [0.1.5] - 2025-07-23
62+
63+
### Changed
64+
65+
- Improved handling of unknown or invalid enum values in device data by logging and removing them during data processing, reducing the chance of errors.
66+
- Streamlined warning logging for device status, ensuring warnings are logged immediately rather than being cached.
67+
- Simplified internal data handling and validation logic for device configuration fields.
68+
69+
## [0.1.4] - 2025-07-22
70+
71+
### Changed
72+
73+
- Improved warning handling to ensure each unique warning is only logged once per session.
74+
- Added support for a new wireless mode labeled "AUTO".
75+
- Enhanced warning messages to prompt users to report unknown remote wireless modes.
76+
77+
## [0.1.3] - 2025-07-22
78+
79+
### Changed
80+
81+
- Updated device status retrieval to always return structured data instead of raw JSON.
82+
83+
### Removed
84+
85+
- Dropped JSON output
86+
- Removed a redundant test related to JSON status output.
87+
88+
## [0.1.2] - 2025-07-22
89+
90+
### Added
91+
92+
- Introduced a comprehensive and strongly typed data model for AirOS device data, enabling structured parsing and validation.
93+
- The device status method now supports returning either a structured object or raw JSON, with improved warning handling for unknown values.
94+
- Updated the README to include an example that prints the wireless mode from the device status.
95+
- Added new test to verify device status retrieval returns structured data objects alongside existing JSON-based tests.
96+
97+
### Changed
98+
99+
- Updated dependencies to include mashumaro and removed asyncio.
100+
- Bumped project version to 0.1.2.
101+
- Changed output/returns from JSON to mashumaro (tnx @joostlek)
102+
103+
## [0.1.1] - 2025-07-21
104+
105+
### Added
106+
107+
- Error/exception handling and raising
108+
109+
## [0.1.0] - 2025-07-20
110+
111+
### Changed
112+
113+
- Improve station reconnect
114+
115+
## [0.0.9] - 2025-07-19
116+
117+
### Added
118+
119+
- Add tests
120+
- Add station reconnect (`stakick`)
121+
122+
## [0.0.8] - 2025-07-16
123+
124+
### Changed
125+
126+
- Reworked exceptions
127+
128+
## [0.0.7] - 2025-07-16
129+
130+
### Changed
131+
132+
- Adjust function returns
133+
134+
## [0.0.6] - 2025-07-16
135+
136+
### Added
137+
138+
- Revert setting verify_ssl, leaving it up to the ingestor to set session
139+
140+
## [0.0.5] - 2025-07-15
141+
142+
### Add
143+
144+
- Add basic testing
145+
- Add renovate for chores
146+
147+
## [0.0.4] - 2025-07-13
148+
149+
### Added
150+
151+
- Improve session handling and ssl, bump version
152+
- Add `pre-commit`, prep `uv`
153+
- Add more actions and pypi publishing
154+
- Switch pypi publishing to Trusted Publishing
155+
- Ensure environment and permissions improving publishing
156+
- Actions and pypi
157+
158+
## [0.0.1] - 2025-07-13
159+
160+
### Added
161+
162+
- Initial commits

0 commit comments

Comments
 (0)