| Name | vista-gateway-client JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Configured client for ISO 19848 protocols and package types. |
| upload_time | 2025-02-19 11:10:29 |
| maintainer | None |
| docs_url | None |
| author | DNV AS |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
vista
iso19848
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vista Gateway Client
Vista Gateway Client is a library that provides a configured client for supported protocols and package types.
It ensures strict implementation and validation of the packages according to their respective supported types.
## Supported Protocols
- **HTTPS**
- **MQTT**
## Supported Package Types
- **ISO19848 DataChannelList**
- **ISO19848 TimeSeriesData**
### What is ISO19848?
ISO 19848 is an international standard for the digital exchange of data between ship systems, covering both operational and technical data.
It standardizes the structure of data for easier exchange and interpretation, facilitating data integration in maritime industries.
- **Schemas:** [ISO19848 schemas](https://github.com/dnv-opensource/vista-sdk/tree/main/schemas/json)
- **Vista documentation:** [docs.vista.dnv.com](docs.vista.dnv.com)
## Acquire an API Key
To use Vista Gateway Client, you will need an API key to authenticate with the gateway.
Please reach out to your DNV contact to request an API key.
When doing so, make sure to mention the specific service you are interested in to ensure you receive the correct key for your use case.
## Installation
To use the Vista Gateway Client, you need **Python >=3.8**. Follow the steps below to install and configure the client.
### 1. Install Package
Install the package using pip:
```sh
pip install vista-gateway-client
```
### 2. Initialize Client
```python
from vista_gateway_client.client import Client
client = Client(
api_key = "<Your API Key>",
protocol = "Http", # or "Mqtt"
)
```
### 3. Create and Send a Package
```python
from vista_gateway_client.gateway_package import ISO19848, DataChannel, TimeSeries
from vista_gateway_client.vista_gateway_exception import VistaGatewayException
# Create package. E.g. ISO19848 DataChannelList
package = DataChannel.Package(
# Configure the package according to ISO 19848 standard
)
# Create client package
client_package = ISO19848.DataChannelList(
package=package,
external_id="<Your External ID>",
correlation_id="<Your Correlation ID>",
user_agent="<Your User Agent>"
)
try:
# Send the package
client.send(client_package)
except VistaGatewayException as e:
# Handle VistaGatewayException
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vista-gateway-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "vista, iso19848",
"author": "DNV AS",
"author_email": "software.support@dnv.com",
"download_url": "https://files.pythonhosted.org/packages/84/de/d6da3770cf845c142f5f225589acba323fa9c5f91c4fa1b660be8777a4ab/vista_gateway_client-0.1.1.tar.gz",
"platform": null,
"description": "# Vista Gateway Client\n\nVista Gateway Client is a library that provides a configured client for supported protocols and package types.\nIt ensures strict implementation and validation of the packages according to their respective supported types.\n\n## Supported Protocols\n\n- **HTTPS**\n- **MQTT**\n\n## Supported Package Types\n- **ISO19848 DataChannelList**\n- **ISO19848 TimeSeriesData**\n\n### What is ISO19848?\n\nISO 19848 is an international standard for the digital exchange of data between ship systems, covering both operational and technical data.\nIt standardizes the structure of data for easier exchange and interpretation, facilitating data integration in maritime industries.\n\n- **Schemas:** [ISO19848 schemas](https://github.com/dnv-opensource/vista-sdk/tree/main/schemas/json)\n- **Vista documentation:** [docs.vista.dnv.com](docs.vista.dnv.com)\n\n\n## Acquire an API Key\n\nTo use Vista Gateway Client, you will need an API key to authenticate with the gateway.\nPlease reach out to your DNV contact to request an API key.\nWhen doing so, make sure to mention the specific service you are interested in to ensure you receive the correct key for your use case.\n\n## Installation\n\nTo use the Vista Gateway Client, you need **Python >=3.8**. Follow the steps below to install and configure the client.\n\n### 1. Install Package\n\nInstall the package using pip:\n\n```sh\npip install vista-gateway-client\n```\n\n### 2. Initialize Client\n\n```python\nfrom vista_gateway_client.client import Client\n\nclient = Client(\n api_key = \"<Your API Key>\",\n protocol = \"Http\", # or \"Mqtt\"\n)\n```\n\n### 3. Create and Send a Package\n\n```python\nfrom vista_gateway_client.gateway_package import ISO19848, DataChannel, TimeSeries\nfrom vista_gateway_client.vista_gateway_exception import VistaGatewayException\n\n# Create package. E.g. ISO19848 DataChannelList\npackage = DataChannel.Package(\n # Configure the package according to ISO 19848 standard\n)\n\n# Create client package\nclient_package = ISO19848.DataChannelList(\n package=package,\n external_id=\"<Your External ID>\",\n correlation_id=\"<Your Correlation ID>\",\n user_agent=\"<Your User Agent>\"\n)\n\ntry:\n # Send the package\n client.send(client_package)\nexcept VistaGatewayException as e:\n # Handle VistaGatewayException\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Configured client for ISO 19848 protocols and package types.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"vista",
" iso19848"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2c7602aaa4493216e85e690b409faf0c029c668e52c10f36d184a41ec25bca60",
"md5": "ac6a53cfd1ffc34bd5e56e29f48f0c28",
"sha256": "a6cd7ac31a7b3c6026a1c738cd0980fe027f7c3f2952a7bd68a5be992d35af22"
},
"downloads": -1,
"filename": "vista_gateway_client-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac6a53cfd1ffc34bd5e56e29f48f0c28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12190,
"upload_time": "2025-02-19T11:10:27",
"upload_time_iso_8601": "2025-02-19T11:10:27.700434Z",
"url": "https://files.pythonhosted.org/packages/2c/76/02aaa4493216e85e690b409faf0c029c668e52c10f36d184a41ec25bca60/vista_gateway_client-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "84ded6da3770cf845c142f5f225589acba323fa9c5f91c4fa1b660be8777a4ab",
"md5": "08460cb8eccf6eb7832c3e74b18a6b54",
"sha256": "10592cfc11b5c6cb5c5c7597c84a86bcb4fae47de2b3d38e26d9eb069c14e41f"
},
"downloads": -1,
"filename": "vista_gateway_client-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "08460cb8eccf6eb7832c3e74b18a6b54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8902,
"upload_time": "2025-02-19T11:10:29",
"upload_time_iso_8601": "2025-02-19T11:10:29.451002Z",
"url": "https://files.pythonhosted.org/packages/84/de/d6da3770cf845c142f5f225589acba323fa9c5f91c4fa1b660be8777a4ab/vista_gateway_client-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 11:10:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vista-gateway-client"
}
