actron-neo-api 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. actron_neo_api-0.0.1/LICENSE +21 -0
  2. actron_neo_api-0.0.1/PKG-INFO +121 -0
  3. actron_neo_api-0.0.1/README.md +104 -0
  4. actron_neo_api-0.0.1/actron_neo_api.egg-info/PKG-INFO +121 -0
  5. actron_neo_api-0.0.1/actron_neo_api.egg-info/SOURCES.txt +9 -0
  6. actron_neo_api-0.0.1/actron_neo_api.egg-info/dependency_links.txt +1 -0
  7. actron_neo_api-0.0.1/actron_neo_api.egg-info/requires.txt +1 -0
  8. actron_neo_api-0.0.1/actron_neo_api.egg-info/top_level.txt +1 -0
  9. actron_neo_api-0.0.1/pyproject.toml +21 -0
  10. actron_neo_api-0.0.1/setup.cfg +4 -0
  11. actron_neo_api-0.0.1/setup.py +22 -0
actron_neo_api-0.0.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Kurt Chrisford
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
actron_neo_api-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,121 @@
1
+ Metadata-Version: 2.1
2
+ Name: actron-neo-api
3
+ Version: 0.0.1
4
+ Summary: Actron Neo API
5
+ Home-page: https://github.com/kclif9/actronneoapi
6
+ Author: Kurt Chrisford
7
+ Author-email: Kurt Chrisford <soft.year7030@fastmail.com>
8
+ Project-URL: Homepage, https://github.com/kclif9/actronneoapi
9
+ Project-URL: Issues, https://github.com/kclif9/actronneoapi/issues
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Python: >=3.8
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: aiohttp>=3.8.0
17
+
18
+ ActronNeoAPI
19
+ ActronNeoAPI is a Python library for interacting with Actron Air Neo API. It allows you to manage and monitor your Actron Air systems programmatically, including retrieving AC system status, events, and more.
20
+
21
+ Features
22
+ Authentication: Authenticate with the Actron Air API using your account credentials.
23
+ AC System Management:
24
+ List all AC systems in your account.
25
+ Retrieve detailed status for a specific AC system.
26
+ Fetch system events, including latest, newer, or older events.
27
+ Fully asynchronous, built using aiohttp.
28
+ Installation
29
+ Install the library via pip:
30
+
31
+ bash
32
+ Copy code
33
+ pip install actronneoapi
34
+ Usage
35
+ 1. Authentication
36
+ To authenticate with the Actron Air API, you need your username, password, a device name, and a unique device identifier.
37
+
38
+ 2. Fetch AC Systems
39
+ Retrieve the list of AC systems associated with your account.
40
+
41
+ 3. Get AC System Status
42
+ Get the full status of a specific AC system by its serial number.
43
+
44
+ 4. Get AC System Events
45
+ Retrieve events for a specific AC system, including the latest, newer, or older events based on an event ID.
46
+
47
+ Example Code
48
+ python
49
+ Copy code
50
+ import asyncio
51
+ from actronneoapi import ActronNeoAPI, ActronNeoAuthError, ActronNeoAPIError
52
+
53
+ async def main():
54
+ username = "your_email@example.com"
55
+ password = "your_password"
56
+ device_name = "my_device"
57
+ device_unique_id = "unique_device_id"
58
+
59
+ api = ActronNeoAPI(username, password)
60
+
61
+ try:
62
+ # Step 1: Authenticate
63
+ await api.request_pairing_token(device_name, device_unique_id)
64
+ await api.request_bearer_token()
65
+
66
+ # Step 2: Fetch AC systems
67
+ systems = await api.get_ac_systems()
68
+ print("AC Systems:", systems)
69
+
70
+ # Get the serial number of the first system
71
+ if systems:
72
+ serial = systems[0].get("serial")
73
+ if serial:
74
+ # Fetch system status
75
+ status = await api.get_ac_status(serial)
76
+ print(f"Status for {serial}:", status)
77
+
78
+ # Fetch latest events
79
+ events = await api.get_ac_events(serial, event_type="latest")
80
+ print(f"Latest events for {serial}:", events)
81
+ except ActronNeoAuthError as auth_error:
82
+ print(f"Authentication failed: {auth_error}")
83
+ except ActronNeoAPIError as api_error:
84
+ print(f"API error: {api_error}")
85
+ except Exception as e:
86
+ print(f"Unexpected error: {e}")
87
+
88
+ # Run the async example
89
+ asyncio.run(main())
90
+ API Methods
91
+ Authentication
92
+ request_pairing_token(device_name: str, device_unique_id: str)
93
+ Requests a pairing token using your Actron Neo credentials and device details.
94
+
95
+ request_bearer_token()
96
+ Exchanges the pairing token for a bearer token required for subsequent API calls.
97
+
98
+ AC Systems
99
+ get_ac_systems()
100
+ Retrieves a list of all AC systems associated with your account.
101
+ AC System Status
102
+ get_ac_status(serial_number: str)
103
+ Retrieves the full status of a specific AC system, including temperature, humidity, zone details, and more.
104
+ AC System Events
105
+ get_ac_events(serial_number: str, event_type: str, event_id: str = None)
106
+ Fetches events for a specific AC system:
107
+ latest: Retrieves the latest events.
108
+ newer: Retrieves events newer than the provided event ID.
109
+ older: Retrieves events older than the provided event ID.
110
+ Requirements
111
+ Python 3.8 or higher
112
+ aiohttp
113
+ Installation Notes
114
+ Ensure you have access to the Actron Neo API by using valid credentials from your Actron Air account.
115
+
116
+ License
117
+ This project is licensed under the MIT License. See the LICENSE file for details.
118
+
119
+ Disclaimer
120
+ This is an unofficial library for the Actron Air API. It is not affiliated, endorsed, or supported by Actron Air. Use at your own risk.
121
+
actron_neo_api-0.0.1/README.md ADDED
@@ -0,0 +1,104 @@
1
+ ActronNeoAPI
2
+ ActronNeoAPI is a Python library for interacting with Actron Air Neo API. It allows you to manage and monitor your Actron Air systems programmatically, including retrieving AC system status, events, and more.
3
+
4
+ Features
5
+ Authentication: Authenticate with the Actron Air API using your account credentials.
6
+ AC System Management:
7
+ List all AC systems in your account.
8
+ Retrieve detailed status for a specific AC system.
9
+ Fetch system events, including latest, newer, or older events.
10
+ Fully asynchronous, built using aiohttp.
11
+ Installation
12
+ Install the library via pip:
13
+
14
+ bash
15
+ Copy code
16
+ pip install actronneoapi
17
+ Usage
18
+ 1. Authentication
19
+ To authenticate with the Actron Air API, you need your username, password, a device name, and a unique device identifier.
20
+
21
+ 2. Fetch AC Systems
22
+ Retrieve the list of AC systems associated with your account.
23
+
24
+ 3. Get AC System Status
25
+ Get the full status of a specific AC system by its serial number.
26
+
27
+ 4. Get AC System Events
28
+ Retrieve events for a specific AC system, including the latest, newer, or older events based on an event ID.
29
+
30
+ Example Code
31
+ python
32
+ Copy code
33
+ import asyncio
34
+ from actronneoapi import ActronNeoAPI, ActronNeoAuthError, ActronNeoAPIError
35
+
36
+ async def main():
37
+ username = "your_email@example.com"
38
+ password = "your_password"
39
+ device_name = "my_device"
40
+ device_unique_id = "unique_device_id"
41
+
42
+ api = ActronNeoAPI(username, password)
43
+
44
+ try:
45
+ # Step 1: Authenticate
46
+ await api.request_pairing_token(device_name, device_unique_id)
47
+ await api.request_bearer_token()
48
+
49
+ # Step 2: Fetch AC systems
50
+ systems = await api.get_ac_systems()
51
+ print("AC Systems:", systems)
52
+
53
+ # Get the serial number of the first system
54
+ if systems:
55
+ serial = systems[0].get("serial")
56
+ if serial:
57
+ # Fetch system status
58
+ status = await api.get_ac_status(serial)
59
+ print(f"Status for {serial}:", status)
60
+
61
+ # Fetch latest events
62
+ events = await api.get_ac_events(serial, event_type="latest")
63
+ print(f"Latest events for {serial}:", events)
64
+ except ActronNeoAuthError as auth_error:
65
+ print(f"Authentication failed: {auth_error}")
66
+ except ActronNeoAPIError as api_error:
67
+ print(f"API error: {api_error}")
68
+ except Exception as e:
69
+ print(f"Unexpected error: {e}")
70
+
71
+ # Run the async example
72
+ asyncio.run(main())
73
+ API Methods
74
+ Authentication
75
+ request_pairing_token(device_name: str, device_unique_id: str)
76
+ Requests a pairing token using your Actron Neo credentials and device details.
77
+
78
+ request_bearer_token()
79
+ Exchanges the pairing token for a bearer token required for subsequent API calls.
80
+
81
+ AC Systems
82
+ get_ac_systems()
83
+ Retrieves a list of all AC systems associated with your account.
84
+ AC System Status
85
+ get_ac_status(serial_number: str)
86
+ Retrieves the full status of a specific AC system, including temperature, humidity, zone details, and more.
87
+ AC System Events
88
+ get_ac_events(serial_number: str, event_type: str, event_id: str = None)
89
+ Fetches events for a specific AC system:
90
+ latest: Retrieves the latest events.
91
+ newer: Retrieves events newer than the provided event ID.
92
+ older: Retrieves events older than the provided event ID.
93
+ Requirements
94
+ Python 3.8 or higher
95
+ aiohttp
96
+ Installation Notes
97
+ Ensure you have access to the Actron Neo API by using valid credentials from your Actron Air account.
98
+
99
+ License
100
+ This project is licensed under the MIT License. See the LICENSE file for details.
101
+
102
+ Disclaimer
103
+ This is an unofficial library for the Actron Air API. It is not affiliated, endorsed, or supported by Actron Air. Use at your own risk.
104
+
actron_neo_api-0.0.1/actron_neo_api.egg-info/PKG-INFO ADDED
@@ -0,0 +1,121 @@
1
+ Metadata-Version: 2.1
2
+ Name: actron-neo-api
3
+ Version: 0.0.1
4
+ Summary: Actron Neo API
5
+ Home-page: https://github.com/kclif9/actronneoapi
6
+ Author: Kurt Chrisford
7
+ Author-email: Kurt Chrisford <soft.year7030@fastmail.com>
8
+ Project-URL: Homepage, https://github.com/kclif9/actronneoapi
9
+ Project-URL: Issues, https://github.com/kclif9/actronneoapi/issues
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Python: >=3.8
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: aiohttp>=3.8.0
17
+
18
+ ActronNeoAPI
19
+ ActronNeoAPI is a Python library for interacting with Actron Air Neo API. It allows you to manage and monitor your Actron Air systems programmatically, including retrieving AC system status, events, and more.
20
+
21
+ Features
22
+ Authentication: Authenticate with the Actron Air API using your account credentials.
23
+ AC System Management:
24
+ List all AC systems in your account.
25
+ Retrieve detailed status for a specific AC system.
26
+ Fetch system events, including latest, newer, or older events.
27
+ Fully asynchronous, built using aiohttp.
28
+ Installation
29
+ Install the library via pip:
30
+
31
+ bash
32
+ Copy code
33
+ pip install actronneoapi
34
+ Usage
35
+ 1. Authentication
36
+ To authenticate with the Actron Air API, you need your username, password, a device name, and a unique device identifier.
37
+
38
+ 2. Fetch AC Systems
39
+ Retrieve the list of AC systems associated with your account.
40
+
41
+ 3. Get AC System Status
42
+ Get the full status of a specific AC system by its serial number.
43
+
44
+ 4. Get AC System Events
45
+ Retrieve events for a specific AC system, including the latest, newer, or older events based on an event ID.
46
+
47
+ Example Code
48
+ python
49
+ Copy code
50
+ import asyncio
51
+ from actronneoapi import ActronNeoAPI, ActronNeoAuthError, ActronNeoAPIError
52
+
53
+ async def main():
54
+ username = "your_email@example.com"
55
+ password = "your_password"
56
+ device_name = "my_device"
57
+ device_unique_id = "unique_device_id"
58
+
59
+ api = ActronNeoAPI(username, password)
60
+
61
+ try:
62
+ # Step 1: Authenticate
63
+ await api.request_pairing_token(device_name, device_unique_id)
64
+ await api.request_bearer_token()
65
+
66
+ # Step 2: Fetch AC systems
67
+ systems = await api.get_ac_systems()
68
+ print("AC Systems:", systems)
69
+
70
+ # Get the serial number of the first system
71
+ if systems:
72
+ serial = systems[0].get("serial")
73
+ if serial:
74
+ # Fetch system status
75
+ status = await api.get_ac_status(serial)
76
+ print(f"Status for {serial}:", status)
77
+
78
+ # Fetch latest events
79
+ events = await api.get_ac_events(serial, event_type="latest")
80
+ print(f"Latest events for {serial}:", events)
81
+ except ActronNeoAuthError as auth_error:
82
+ print(f"Authentication failed: {auth_error}")
83
+ except ActronNeoAPIError as api_error:
84
+ print(f"API error: {api_error}")
85
+ except Exception as e:
86
+ print(f"Unexpected error: {e}")
87
+
88
+ # Run the async example
89
+ asyncio.run(main())
90
+ API Methods
91
+ Authentication
92
+ request_pairing_token(device_name: str, device_unique_id: str)
93
+ Requests a pairing token using your Actron Neo credentials and device details.
94
+
95
+ request_bearer_token()
96
+ Exchanges the pairing token for a bearer token required for subsequent API calls.
97
+
98
+ AC Systems
99
+ get_ac_systems()
100
+ Retrieves a list of all AC systems associated with your account.
101
+ AC System Status
102
+ get_ac_status(serial_number: str)
103
+ Retrieves the full status of a specific AC system, including temperature, humidity, zone details, and more.
104
+ AC System Events
105
+ get_ac_events(serial_number: str, event_type: str, event_id: str = None)
106
+ Fetches events for a specific AC system:
107
+ latest: Retrieves the latest events.
108
+ newer: Retrieves events newer than the provided event ID.
109
+ older: Retrieves events older than the provided event ID.
110
+ Requirements
111
+ Python 3.8 or higher
112
+ aiohttp
113
+ Installation Notes
114
+ Ensure you have access to the Actron Neo API by using valid credentials from your Actron Air account.
115
+
116
+ License
117
+ This project is licensed under the MIT License. See the LICENSE file for details.
118
+
119
+ Disclaimer
120
+ This is an unofficial library for the Actron Air API. It is not affiliated, endorsed, or supported by Actron Air. Use at your own risk.
121
+
actron_neo_api-0.0.1/actron_neo_api.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,9 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ setup.py
5
+ actron_neo_api.egg-info/PKG-INFO
6
+ actron_neo_api.egg-info/SOURCES.txt
7
+ actron_neo_api.egg-info/dependency_links.txt
8
+ actron_neo_api.egg-info/requires.txt
9
+ actron_neo_api.egg-info/top_level.txt
actron_neo_api-0.0.1/actron_neo_api.egg-info/requires.txt ADDED
@@ -0,0 +1 @@
1
+ aiohttp>=3.8.0
actron_neo_api-0.0.1/pyproject.toml ADDED
@@ -0,0 +1,21 @@
1
+ [project]
2
+ name = "actron-neo-api"
3
+ version = "0.0.1"
4
+ authors = [
5
+ { name="Kurt Chrisford", email="soft.year7030@fastmail.com" },
6
+ ]
7
+ description = "Actron Neo API"
8
+ readme = "README.md"
9
+ requires-python = ">=3.8"
10
+ classifiers = [
11
+ "Programming Language :: Python :: 3",
12
+ "License :: OSI Approved :: MIT License",
13
+ "Operating System :: OS Independent",
14
+ ]
15
+ dependencies = [
16
+ "aiohttp>=3.8.0"
17
+ ]
18
+
19
+ [project.urls]
20
+ Homepage = "https://github.com/kclif9/actronneoapi"
21
+ Issues = "https://github.com/kclif9/actronneoapi/issues"
actron_neo_api-0.0.1/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
actron_neo_api-0.0.1/setup.py ADDED
@@ -0,0 +1,22 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ setup(
4
+ name="actron-neo-api",
5
+ version="0.1.0",
6
+ author="Kurt Chrisford",
7
+ author_email="soft.year7030@fastmail.com",
8
+ description="Python API wrapper for the Actron Neo API.",
9
+ long_description=open("README.md").read(),
10
+ long_description_content_type="text/markdown",
11
+ url="https://github.com/kclif9/actronneoapi",
12
+ packages=find_packages(),
13
+ install_requires=[
14
+ "aiohttp>=3.8.0",
15
+ ],
16
+ classifiers=[
17
+ "Programming Language :: Python :: 3",
18
+ "License :: OSI Approved :: MIT License",
19
+ "Operating System :: OS Independent",
20
+ ],
21
+ python_requires=">=3.8",
22
+ )