| Name | azuresphere-device-api JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | |
| Summary | A library for interacting with Azure Sphere devices using the inbuilt REST server. |
| upload_time | 2023-06-30 12:21:49 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
azure
sphere
device
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Microsoft Azure Sphere Device REST APIs for Python
Microsoft Azure Sphere Device REST APIs for Python enables users to interact with an Azure Sphere device using REST APIs.
## Installation
You can find Microsoft Azure Sphere Device REST APIs for Python on [PyPi](https://pypi.org/project/azuresphere_device_api/).
1. If you haven't already, [install and/or upgrade the pip](https://pip.pypa.io/en/stable/installing/)
of your Python environment to a recent version.
2. Run `pip install azuresphere_device_api`.
## Usage
Before using Microsoft Azure Sphere Device REST APIs for Python, you must install the Azure Sphere SDK.
- To install the Azure Sphere SDK on Windows, follow the [Windows Quickstart](https://learn.microsoft.com/azure-sphere/install/install-sdk?pivots=cli).
- To install the Azure Sphere SDK on Linux, follow the [Linux Quickstart](https://learn.microsoft.com/azure-sphere/install/install-sdk-linux?pivots=cli-linux).
### Sample
The [display_ip_deviceid sample](https://github.com/Azure/azure-sphere-tools/blob/main/Manufacturing/src/Python/device_api_sample) gets the list of attached devices, displays the device IP address, and device ID.
### Active device IP address
By default, this package will target Azure Sphere devices with IP address `192.168.35.2`. To change the active Azure Sphere device, call `set_active_device_ip_address` API as below:
```
from azuresphere_device_api import devices
devices.set_active_device_ip_address("<Device_Ip_Address")
```
## Documentation
Microsoft Azure Sphere Device REST APIs for Python documentation is available at [Azure Sphere Device REST APIs Docs](https://github.com/Azure/azure-sphere-tools/blob/main/Manufacturing/src).
## Supported host operating systems
- Windows 10 and 11
- Ubuntu 18.04, 20.04, 22.04
Raw data
{
"_id": null,
"home_page": "",
"name": "azuresphere-device-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "azure,sphere,device,api",
"author": "",
"author_email": "Microsoft <azspheremfrsamplesup@microsoft.com>",
"download_url": "https://files.pythonhosted.org/packages/ef/7f/173a252d9ab0a7e6f2a39c599a252b4673e48f29e8aced21150bea3d0172/azuresphere-device-api-1.1.1.tar.gz",
"platform": null,
"description": "# Microsoft Azure Sphere Device REST APIs for Python\r\n\r\nMicrosoft Azure Sphere Device REST APIs for Python enables users to interact with an Azure Sphere device using REST APIs.\r\n\r\n## Installation\r\n\r\nYou can find Microsoft Azure Sphere Device REST APIs for Python on [PyPi](https://pypi.org/project/azuresphere_device_api/).\r\n\r\n1. If you haven't already, [install and/or upgrade the pip](https://pip.pypa.io/en/stable/installing/)\r\n of your Python environment to a recent version.\r\n2. Run `pip install azuresphere_device_api`.\r\n\r\n## Usage\r\n\r\nBefore using Microsoft Azure Sphere Device REST APIs for Python, you must install the Azure Sphere SDK.\r\n\r\n- To install the Azure Sphere SDK on Windows, follow the [Windows Quickstart](https://learn.microsoft.com/azure-sphere/install/install-sdk?pivots=cli).\r\n- To install the Azure Sphere SDK on Linux, follow the [Linux Quickstart](https://learn.microsoft.com/azure-sphere/install/install-sdk-linux?pivots=cli-linux).\r\n\r\n### Sample\r\n\r\nThe [display_ip_deviceid sample](https://github.com/Azure/azure-sphere-tools/blob/main/Manufacturing/src/Python/device_api_sample) gets the list of attached devices, displays the device IP address, and device ID.\r\n\r\n### Active device IP address\r\n\r\nBy default, this package will target Azure Sphere devices with IP address `192.168.35.2`. To change the active Azure Sphere device, call `set_active_device_ip_address` API as below:\r\n\r\n```\r\nfrom azuresphere_device_api import devices\r\ndevices.set_active_device_ip_address(\"<Device_Ip_Address\")\r\n```\r\n\r\n## Documentation\r\n\r\nMicrosoft Azure Sphere Device REST APIs for Python documentation is available at [Azure Sphere Device REST APIs Docs](https://github.com/Azure/azure-sphere-tools/blob/main/Manufacturing/src).\r\n\r\n## Supported host operating systems\r\n\r\n- Windows 10 and 11\r\n- Ubuntu 18.04, 20.04, 22.04\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A library for interacting with Azure Sphere devices using the inbuilt REST server.",
"version": "1.1.1",
"project_urls": null,
"split_keywords": [
"azure",
"sphere",
"device",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9109f7faa954f1cb18a93913c01a9cb703cfc93f81554940871d3c1063e7b96f",
"md5": "22944b1c1276421f1dd44f6666929602",
"sha256": "5fde24a526eb48da1e32f6c41971d7e722332ec76fe6cc364f5e9a2ea6875f0e"
},
"downloads": -1,
"filename": "azuresphere_device_api-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22944b1c1276421f1dd44f6666929602",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23968,
"upload_time": "2023-06-30T12:21:47",
"upload_time_iso_8601": "2023-06-30T12:21:47.709983Z",
"url": "https://files.pythonhosted.org/packages/91/09/f7faa954f1cb18a93913c01a9cb703cfc93f81554940871d3c1063e7b96f/azuresphere_device_api-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef7f173a252d9ab0a7e6f2a39c599a252b4673e48f29e8aced21150bea3d0172",
"md5": "b34b60b0213a3143771cdcc1e685d648",
"sha256": "b554d2f96fd24a9eb72d7857c350e854c13201a42476ca71e1243481e2f16de3"
},
"downloads": -1,
"filename": "azuresphere-device-api-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b34b60b0213a3143771cdcc1e685d648",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17930,
"upload_time": "2023-06-30T12:21:49",
"upload_time_iso_8601": "2023-06-30T12:21:49.367023Z",
"url": "https://files.pythonhosted.org/packages/ef/7f/173a252d9ab0a7e6f2a39c599a252b4673e48f29e8aced21150bea3d0172/azuresphere-device-api-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-30 12:21:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "azuresphere-device-api"
}
