pyimouapi 1.0.0__tar.gz

pyimouapi-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [IMOU]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyimouapi-1.0.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: pyimouapi
+Version: 1.0.0
+Summary: A package for imou open api
+Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
+Author: Imou-OpenPlatform
+Author-email: cloud_openteam_service@imou.com
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Py-Imou-Open-Api
+
+开放平台apiSDK python语言版 owner :  姚翔1  (308581)
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

pyimouapi-1.0.0/README.md

@@ -0,0 +1,92 @@
+# Py-Imou-Open-Api
+
+开放平台apiSDK python语言版 owner :  姚翔1  (308581)
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

pyimouapi-1.0.0/pyimouapi/__init__.py

@@ -0,0 +1,3 @@
+from .device import ImouDeviceManager, ImouDevice, ImouChannel
+from .exceptions import ConnectFailedException, RequestFailedException, InvalidAppIdOrSecretException
+from .openapi import ImouOpenApiClient

pyimouapi-1.0.0/pyimouapi/const.py

@@ -0,0 +1,69 @@
+# API Endpoints
+API_ENDPOINT_ACCESS_TOKEN = "/openapi/accessToken"
+API_ENDPOINT_LIST_DEVICE_DETAILS = "/openapi/listDeviceDetailsByPage"
+API_ENDPOINT_CONTROL_DEVICE_PTZ = "/openapi/controlMovePTZ"
+API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS = "/openapi/modifyDeviceAlarmStatus"
+API_ENDPOINT_GET_DEVICE_ALARM_PARAM = "/openapi/getDeviceAlarmParam"
+API_ENDPOINT_GET_DEVICE_STATUS = "/openapi/getDeviceCameraStatus"
+API_ENDPOINT_SET_DEVICE_STATUS = "/openapi/setDeviceCameraStatus"
+API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE = "/openapi/getNightVisionMode"
+API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE = "/openapi/setNightVisionMode"
+API_ENDPOINT_DEVICE_STORAGE = "/openapi/deviceStorage"
+API_ENDPOINT_RESTART_DEVICE = "/openapi/restartDevice"
+API_ENDPOINT_BIND_DEVICE_LIVE = "/openapi/bindDeviceLive"
+API_ENDPOINT_GET_DEVICE_ONLINE = "/openapi/deviceOnline"
+API_ENDPOINT_GET_DEVICE_LIVE_INFO = "/openapi/getLiveStreamInfo"
+API_ENDPOINT_SET_DEVICE_SNAP = "/openapi/setDeviceSnapEnhanced"
+API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES = "/openapi/getIotDeviceProperties"
+API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES = "/openapi/setIotDeviceProperties"
+API_ENDPOINT_DEVICE_SD_CARD_STATUS = "/openapi/deviceSdcardStatus"
+
+# error_codes
+ERROR_CODE_SUCCESS = "0"
+ERROR_CODE_TOKEN_OVERDUE = "TK1002"
+ERROR_CODE_INVALID_SIGN = "SN1001"
+ERROR_CODE_INVALID_APP = "SN1004"
+ERROR_CODE_DEVICE_OFFLINE = "DV1007"
+
+# params key
+PARAM_APP_ID = "appId"
+PARAM_APP_SECRET = "appSecret"
+PARAM_SYSTEM = "system"
+PARAM_ACCESS_TOKEN = "accessToken"
+PARAM_CURRENT_DOMAIN = "currentDomain"
+PARAM_DEVICE_ID = "deviceId"
+PARAM_CHANNEL_ID = "channelId"
+PARAM_VER = "ver"
+PARAM_SIGN = "sign"
+PARAM_TIME = "time"
+PARAM_NONCE = "nonce"
+PARAM_PARAMS = "params"
+PARAM_ID = "id"
+PARAM_RESULT = "result"
+PARAM_CODE = "code"
+PARAM_MSG = "msg"
+PARAM_DATA = "data"
+PARAM_PAGE = "page"
+PARAM_PAGE_SIZE = "pageSize"
+PARAM_TOKEN = "token"
+PARAM_PRODUCT_ID = "productId"
+PARAM_CHANNEL_NUM = "channelNum"
+PARAM_MODE = "mode"
+PARAM_ENABLE_TYPE = "enableType"
+PARAM_ENABLE = "enable"
+PARAM_COUNT = "count"
+PARAM_DEVICE_LIST = "deviceList"
+PARAM_DEVICE_NAME = "deviceName"
+PARAM_DEVICE_STATUS = "deviceStatus"
+PARAM_DEVICE_ABILITY = "deviceAbility"
+PARAM_DEVICE_VERSION = "deviceVersion"
+PARAM_BRAND = "brand"
+PARAM_DEVICE_MODEL = "deviceModel"
+PARAM_CHANNEL_LIST = "channelList"
+PARAM_CHANNEL_NAME = "channelName"
+PARAM_CHANNEL_STATUS = "channelStatus"
+PARAM_CHANNEL_ABILITY = "channelAbility"
+PARAM_STREAM_ID = "streamId"
+PARAM_OPERATION = "operation"
+PARAM_DURATION = "duration"
+PARAM_PROPERTIES = "properties"

pyimouapi-1.0.0/pyimouapi/device.py

@@ -0,0 +1,283 @@
+from .const import API_ENDPOINT_LIST_DEVICE_DETAILS, PARAM_PAGE_SIZE, PARAM_PAGE, \
+    PARAM_DEVICE_ID, PARAM_CHANNEL_ID, API_ENDPOINT_CONTROL_DEVICE_PTZ, API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS, \
+    API_ENDPOINT_GET_DEVICE_STATUS, API_ENDPOINT_SET_DEVICE_STATUS, API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE, \
+    API_ENDPOINT_DEVICE_STORAGE, API_ENDPOINT_RESTART_DEVICE, API_ENDPOINT_BIND_DEVICE_LIVE, \
+    API_ENDPOINT_GET_DEVICE_ONLINE, API_ENDPOINT_GET_DEVICE_LIVE_INFO, API_ENDPOINT_SET_DEVICE_SNAP, PARAM_MODE, \
+    PARAM_ENABLE_TYPE, PARAM_ENABLE, PARAM_COUNT, PARAM_DEVICE_LIST, PARAM_DEVICE_NAME, PARAM_DEVICE_STATUS, \
+    PARAM_DEVICE_ABILITY, PARAM_DEVICE_VERSION, PARAM_BRAND, PARAM_DEVICE_MODEL, PARAM_CHANNEL_LIST, PARAM_CHANNEL_NAME, \
+    PARAM_CHANNEL_STATUS, PARAM_CHANNEL_ABILITY, PARAM_STREAM_ID, PARAM_OPERATION, PARAM_DURATION, \
+    API_ENDPOINT_GET_DEVICE_ALARM_PARAM, API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE, PARAM_PRODUCT_ID, PARAM_PROPERTIES, \
+    API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES, API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES, API_ENDPOINT_DEVICE_SD_CARD_STATUS, \
+    PARAM_CHANNEL_NUM
+from .openapi import ImouOpenApiClient
+
+
+class ImouChannel:
+
+    def __init__(self, channel_id: str, channel_name: str, channel_status: str, channel_ability: str):
+        self._channel_id = channel_id
+        self._channel_name = channel_name
+        self._channel_status = channel_status
+        self._channel_ability = channel_ability
+
+    @property
+    def channel_id(self) -> str:
+        return self._channel_id
+
+    @property
+    def channel_name(self) -> str:
+        return self._channel_name
+
+    @property
+    def channel_status(self) -> str:
+        return self._channel_status
+
+    @property
+    def channel_ability(self) -> str:
+        return self._channel_ability
+
+
+class ImouDevice:
+
+    def __init__(self, device_id: str, device_name: str, device_status: str,
+                 device_ability: str, brand: str, device_model: str, device_version: str):
+        self._device_id = device_id
+        self._device_name = device_name
+        self._device_status = device_status
+        self._device_ability = device_ability
+        self._brand = brand
+        self._device_model = device_model
+        self._device_version = device_version
+        self._channel_number = 0
+        self._channels = []
+        self._product_id = None
+
+    @property
+    def device_id(self) -> str:
+        return self._device_id
+
+    @property
+    def device_name(self) -> str:
+        return self._device_name
+
+    @property
+    def device_status(self) -> str:
+        return self._device_status
+
+    @property
+    def channels(self) -> []:
+        return self._channels
+
+    @property
+    def device_ability(self) -> str:
+        return self._device_ability
+
+    @property
+    def brand(self) -> str:
+        return self._brand
+
+    @property
+    def device_model(self) -> str:
+        return self._device_model
+
+    @property
+    def device_version(self) -> str:
+        return self._device_version
+
+    @property
+    def product_id(self) -> str:
+        return self._product_id
+
+    @property
+    def channel_number(self) -> int:
+        return self._channel_number
+
+    def set_product_id(self, product_id: str) -> None:
+        self._product_id = product_id
+
+    def set_channels(self, channels: []) -> None:
+        self._channels = channels
+
+    def set_channel_number(self, channel_number: int):
+        self._channel_number = channel_number
+
+
+class ImouDeviceManager:
+    def __init__(self, imouApiClient: ImouOpenApiClient):
+        self._imouApiClient = imouApiClient
+
+    async def async_get_devices(self, page: int = 1, page_size: int = 10) -> [ImouDevice]:
+        """GET DEVICE LIST"""
+        params = {
+            PARAM_PAGE: page,
+            PARAM_PAGE_SIZE: page_size,
+        }
+        data = await self._imouApiClient.async_request_api(API_ENDPOINT_LIST_DEVICE_DETAILS, params)
+        if data[PARAM_COUNT] == 0:
+            return []
+        devices = []
+        for device in data[PARAM_DEVICE_LIST]:
+            device_id = device[PARAM_DEVICE_ID]
+            device_name = device[PARAM_DEVICE_NAME]
+            device_status = device[PARAM_DEVICE_STATUS]
+            device_ability = device[PARAM_DEVICE_ABILITY]
+            device_version = device[PARAM_DEVICE_VERSION]
+            brand = device[PARAM_BRAND]
+            device_model = device[PARAM_DEVICE_MODEL]
+            imou_device = ImouDevice(device_id, device_name, device_status, device_ability, brand, device_model,
+                                     device_version)
+            if PARAM_PRODUCT_ID in device:
+                imou_device.set_product_id(device[PARAM_PRODUCT_ID])
+            if PARAM_CHANNEL_NUM in device:
+                imou_device.set_channel_number(device[PARAM_CHANNEL_NUM])
+            if PARAM_CHANNEL_LIST in device:
+                channel_list = device[PARAM_CHANNEL_LIST]
+                channels = []
+                for channel in channel_list:
+                    channel_id = channel[PARAM_CHANNEL_ID]
+                    channel_name = channel[PARAM_CHANNEL_NAME]
+                    channel_status = channel[PARAM_CHANNEL_STATUS]
+                    if PARAM_CHANNEL_ABILITY in channel:
+                        channel_ability = channel[PARAM_CHANNEL_ABILITY]
+                    else:
+                        channel_ability = device_ability
+                    channel = ImouChannel(channel_id, channel_name, channel_status, channel_ability)
+                    channels.append(channel)
+                imou_device.set_channels(channels)
+            devices.append(imou_device)
+        # If the return quantity is equal to the requested quantity, continue to request the next page
+        if data[PARAM_COUNT] == page_size:
+            devices.append(self.async_get_devices(page + 1, page_size))
+        return devices
+
+    async def async_control_device_ptz(self, device_id: str, channel_id: str, operation: int,
+                                       duration: int = 500) -> None:
+        """control ptz"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_OPERATION: operation,
+            PARAM_DURATION: duration
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_CONTROL_DEVICE_PTZ, params)
+
+    async def async_modify_device_alarm_status(self, device_id: str, channel_id: str, enabled: bool) -> None:
+        """SET DEVICE ALARM STATUS"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_ENABLE: enabled,
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS, params)
+
+    async def async_get_device_status(self, device_id: str, channel_id: str, enable_type: str) -> dict:
+        """obtain device capability switch status"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_ENABLE_TYPE: enable_type
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_GET_DEVICE_STATUS, params)
+
+    async def async_get_device_online_status(self, device_id: str) -> dict:
+        """GET DEVICE ONLINE STATUS"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_GET_DEVICE_ONLINE, params)
+
+    async def async_set_device_status(self, device_id: str, channel_id: str, enable_type: str, enable: bool) -> None:
+
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_ENABLE_TYPE: enable_type,
+            PARAM_ENABLE: enable
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_SET_DEVICE_STATUS, params)
+
+    async def async_get_device_night_vision_mode(self, device_id: str, channel_id: str) -> dict:
+        """obtain device night vision mode"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE, params)
+
+    async def async_set_device_night_vision_mode(self, device_id: str, channel_id: str,
+                                                 night_vision_mode: str) -> None:
+        """set device night vision mode"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_MODE: night_vision_mode
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE, params)
+
+    async def async_get_device_storage(self, device_id: str) -> dict:
+        """obtain device storage media capacity information"""
+        params = {
+            PARAM_DEVICE_ID: device_id
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_DEVICE_STORAGE, params)
+
+    async def async_restart_device(self, device_id: str) -> None:
+        """reboot device"""
+        params = {
+            PARAM_DEVICE_ID: device_id
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_RESTART_DEVICE, params)
+
+    async def async_get_stream_url(self, device_id: str, channel_id: str, stream_id: int = 0) -> dict:
+        """obtain the hls stream address of the device"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_GET_DEVICE_LIVE_INFO, params)
+
+    async def async_get_device_snap(self, device_id: str, channel_id: str) -> dict:
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_SET_DEVICE_SNAP, params)
+
+    async def async_create_stream_url(self, device_id: str, channel_id: str, stream_id: int = 0) -> dict:
+        """create device hls stream address"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_STREAM_ID: stream_id
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_BIND_DEVICE_LIVE, params)
+
+    async def async_get_device_alarm_param(self, device_id: str, channel_id: str) -> None:
+        """set device alarm status"""
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_GET_DEVICE_ALARM_PARAM, params)
+
+    async def async_get_iot_device_properties(self, device_id: str, product_id: str, properties: []) -> dict:
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_PRODUCT_ID: product_id,
+            PARAM_PROPERTIES: properties
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES, params)
+
+    async def async_set_iot_device_properties(self, device_id: str, product_id: str, properties: dict) -> None:
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_PRODUCT_ID: product_id,
+            PARAM_PROPERTIES: properties
+        }
+        await self._imouApiClient.async_request_api(API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES, params)
+
+    async def async_get_device_sd_card_status(self, device_id: str) -> dict:
+        params = {
+            PARAM_DEVICE_ID: device_id
+        }
+        return await self._imouApiClient.async_request_api(API_ENDPOINT_DEVICE_SD_CARD_STATUS, params)

pyimouapi-1.0.0/pyimouapi/exceptions.py

@@ -0,0 +1,46 @@
+import sys
+import traceback
+
+
+class ImouException(Exception):
+    def __init__(self, message: str = "") -> None:
+        """Initialize."""
+        self.message = message
+        super().__init__(self.message)
+
+    def to_string(self) -> str:
+        """Return the exception as a string."""
+        return f"{self.__class__.__name__}: {self.message}\n" + self.traceback()
+
+    def traceback(self) -> str:
+        """Return the traceback as a string."""
+        etype, value, trace = sys.exc_info()
+        return "".join(traceback.format_exception(etype, value, trace, None))
+
+    def get_title(self) -> str:
+        """Return the title of the exception which will be then translated."""
+        return "generic_error"
+
+
+class ConnectFailedException(ImouException):
+    """connectFailedException. """
+
+    def get_title(self) -> str:
+        """Return the title of the exception which will be then translated."""
+        return "connect_failed"
+
+
+class RequestFailedException(ImouException):
+    """requestFailedException """
+
+    def get_title(self) -> str:
+        """Return the title of the exception which will be then translated."""
+        return "request_failed"
+
+
+class InvalidAppIdOrSecretException(ImouException):
+    """invalidAppIdOrSecretException """
+
+    def get_title(self) -> str:
+        """Return the title of the exception which will be then translated."""
+        return "appIdOrSecret_invalid"

pyimouapi-1.0.0/pyimouapi/openapi.py

@@ -0,0 +1,89 @@
+import hashlib
+import json
+import logging
+import secrets
+import time
+import uuid
+
+import aiohttp
+import async_timeout
+
+from .const import API_ENDPOINT_ACCESS_TOKEN, ERROR_CODE_INVALID_APP, \
+    ERROR_CODE_INVALID_SIGN, \
+    ERROR_CODE_SUCCESS, ERROR_CODE_TOKEN_OVERDUE, PARAM_ACCESS_TOKEN, PARAM_SYSTEM, PARAM_VER, PARAM_SIGN, PARAM_APP_ID, \
+    PARAM_TIME, PARAM_NONCE, PARAM_PARAMS, PARAM_ID, PARAM_RESULT, PARAM_DATA, PARAM_CODE, PARAM_TOKEN, PARAM_MSG, \
+    PARAM_CURRENT_DOMAIN
+from .exceptions import ConnectFailedException, RequestFailedException, \
+    InvalidAppIdOrSecretException
+
+_LOGGER: logging.Logger = logging.getLogger(__package__)
+
+
+class ImouOpenApiClient:
+
+    def __init__(self, app_id: str, app_secret: str, api_url: str) -> None:
+        self._app_id = app_id
+        self._app_secret = app_secret
+        self._api_url = api_url
+        # token
+        self._access_token = None
+
+    async def async_get_token(self) -> None:
+        """get accessToken"""
+        response = await self.async_request_api(API_ENDPOINT_ACCESS_TOKEN, {})
+        self._access_token = response[PARAM_ACCESS_TOKEN]
+        self._api_url=response[PARAM_CURRENT_DOMAIN].split("://")[1]
+
+    async def async_request_api(self, endpoint: str, params: dict[any, any] = None) -> dict[any, any]:
+        # if accessToken is None , get first
+        if self._access_token is None and endpoint != API_ENDPOINT_ACCESS_TOKEN:
+            await self.async_get_token()
+        if endpoint != API_ENDPOINT_ACCESS_TOKEN:
+            params[PARAM_TOKEN] = self._access_token
+        timestamp = round(time.time())
+        nonce = secrets.token_urlsafe()
+        sign = hashlib.md5(f"time:{timestamp},nonce:{nonce},appSecret:{self._app_secret}".encode("utf-8")).hexdigest()
+        request_id = str(uuid.uuid4())
+        headers = {
+            "Content-Type": "application/json",
+            "Client-Type": "HomeAssistant"
+        }
+        body = {
+            PARAM_SYSTEM: {
+                PARAM_VER: "1.0",
+                PARAM_SIGN: sign,
+                PARAM_APP_ID: self._app_id,
+                PARAM_TIME: timestamp,
+                PARAM_NONCE: nonce,
+            },
+            PARAM_PARAMS: params,
+            PARAM_ID: request_id,
+        }
+        url = f"https://{self._api_url}{endpoint}"
+        try:
+            async with aiohttp.ClientSession() as session:
+                async with async_timeout.timeout(30):
+                    response = await session.request("POST", url, json=body, headers=headers)
+                    response_body = json.loads(await response.text())
+                    _LOGGER.info(f"url: {url} request body: {body} response: {response_body}")
+        except Exception as exception:
+            raise ConnectFailedException(f"connect failed,{exception}") from exception
+        if response.status != 200:
+            raise RequestFailedException(f"request failed,status code {response.status}")
+        result_code = response_body[PARAM_RESULT][PARAM_CODE]
+        result_message = response_body[PARAM_RESULT][PARAM_MSG]
+        if result_code != ERROR_CODE_SUCCESS:
+            msg = result_code + ":" + result_message
+            if result_code in (ERROR_CODE_INVALID_SIGN, ERROR_CODE_INVALID_APP):
+                raise InvalidAppIdOrSecretException(msg)
+            if result_code == ERROR_CODE_TOKEN_OVERDUE:
+                await self.async_get_token()
+                return await self.async_request_api(endpoint, params)
+            raise RequestFailedException(msg)
+        response_data = response_body[PARAM_RESULT][PARAM_DATA] if PARAM_DATA in response_body[PARAM_RESULT] else {}
+        return response_data
+
+    @property
+    def access_token(self):
+        return self._access_token
+

pyimouapi-1.0.0/pyimouapi.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: pyimouapi
+Version: 1.0.0
+Summary: A package for imou open api
+Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
+Author: Imou-OpenPlatform
+Author-email: cloud_openteam_service@imou.com
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Py-Imou-Open-Api
+
+开放平台apiSDK python语言版 owner :  姚翔1  (308581)
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://hcyfgit.imou.com/PublicCloud/Ecology/Py-Imou-Open-Api/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

pyimouapi-1.0.0/pyimouapi.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+setup.py
+pyimouapi/__init__.py
+pyimouapi/const.py
+pyimouapi/device.py
+pyimouapi/exceptions.py
+pyimouapi/openapi.py
+pyimouapi.egg-info/PKG-INFO
+pyimouapi.egg-info/SOURCES.txt
+pyimouapi.egg-info/dependency_links.txt
+pyimouapi.egg-info/top_level.txt

pyimouapi-1.0.0/pyimouapi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyimouapi-1.0.0/pyimouapi.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyimouapi

pyimouapi-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyimouapi-1.0.0/setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='pyimouapi',
+    version='1.0.0',
+    packages=find_packages(),
+    description='A package for imou open api',
+    # long_description=open('README.md').read(),
+    # python3，readme文件中文报错
+    long_description=open('README.md', encoding='utf-8').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api',
+    author='Imou-OpenPlatform',
+    author_email='cloud_openteam_service@imou.com',
+    license='MIT',
+    install_requires=[
+        # 依赖列表
+    ],
+    classifiers=[
+        # 分类信息
+    ]
+)