omlox_client_README.md

omlox

Note: This API definition is not the official omlox Hub standard. The official omlox Hub API & behaviour specification, which describes in detail how the omlox hub works, is only accessible to registered PNO members.

The omlox_client package is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.omlox.com

Requirements.

Python 3.9+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 2.1.0, < 3.0.0
• python-dateutil >= 2.8.2
• aiohttp >= 3.8.4
• aiohttp-retry >= 2.8.3
• pydantic >= 2
• typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with omlox, you can run the following:

import omlox_client
from omlox_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://omlox.com/fileadmin/api/127.0.0.1
# See configuration.py for a list of all supported configuration parameters.
configuration = omlox_client.Configuration(
    host = "https://omlox.com/fileadmin/api/127.0.0.1"
)



# Enter a context with an instance of the API client
async with omlox_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = omlox_client.FencesApi(api_client)
    fence = omlox_client.Fence() # Fence | 
    subdivide = True # bool | If true, points will be added automatically to the submitted geometry to limit the distance between subsequent points. (optional)

    try:
        # Create a fence.
        api_response = await api_instance.create_fence(fence, subdivide=subdivide)
        print("The response of FencesApi->create_fence:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FencesApi->create_fence: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://omlox.com/fileadmin/api/127.0.0.1

Class	Method	HTTP request	Description
FencesApi	create_fence	POST /fences	Create a fence.
FencesApi	delete_fence_by_id	DELETE /fences/{fence_id}	Delete a fence.
FencesApi	delete_fences	DELETE /fences	Delete all fences.
FencesApi	get_all_fence_ids	GET /fences	Get an array of all fence ids.
FencesApi	get_all_fences	GET /fences/summary	Get an array of all fences.
FencesApi	get_fence_by_id	GET /fences/{fence_id}	Get a fence.
FencesApi	get_locations_inside_fence	GET /fences/{fence_id}/locations	Get location data of all location providers within a fence.
FencesApi	get_providers_inside_fence	GET /fences/{fence_id}/providers	Get all location providers within a fence.
FencesApi	get_trackable_motions_inside_fence	GET /fences/{fence_id}/motions	Get motion data of all trackables within a fence.
FencesApi	get_trackables_inside	GET /fences/{fence_id}/trackables	Get all trackables within a fence.
FencesApi	update_fence_by_id	PUT /fences/{fence_id}	Update a fence.
ProvidersApi	create_location_provider	POST /providers	Create a location provider.
ProvidersApi	delete_locations	DELETE /providers/locations	Delete all location providers.
ProvidersApi	delete_provider_by_id	DELETE /providers/{provider_id}	Delete location provider.
ProvidersApi	delete_provider_location_by_id	DELETE /providers/{provider_id}/location	Delete location of location provider.
ProvidersApi	delete_providers	DELETE /providers	Delete all location providers.
ProvidersApi	get_all_locations	GET /providers/locations	Get all locations.
ProvidersApi	get_all_provider_objects	GET /providers/summary	Get an array of all location providers.
ProvidersApi	get_inside_fence_for_provider	GET /providers/{provider_id}/fences	Get all fences the location provider is within.
ProvidersApi	get_location_by_provider_id	GET /providers/{provider_id}/location	Get location.
ProvidersApi	get_location_provider_ids	GET /providers	Get an array of all location provider ids.
ProvidersApi	get_provider_by_id	GET /providers/{provider_id}	Get a location provider.
ProvidersApi	get_sensors_by_provider_id	GET /providers/{provider_id}/sensors	Get sensor data.
ProvidersApi	providers_provider_id_trackables_get	GET /providers/{provider_id}/trackables	Get all trackable bound to a specific location provider
ProvidersApi	update_location_by_provider_id	PUT /providers/{provider_id}/location	Update location.
ProvidersApi	update_locations	PUT /providers/locations	Update locations.
ProvidersApi	update_provider_by_id	PUT /providers/{provider_id}	Update a location provider.
ProvidersApi	update_proximities	PUT /providers/proximities	Bulk update of locations based on proximity events.
ProvidersApi	update_proximity_by_provider_id	PUT /providers/{provider_id}/proximity	Update location of location provider via a proximity event.
ProvidersApi	update_sensors_by_provider_id	PUT /providers/{provider_id}/sensors	Update sensor data.
TrackablesApi	create_new_trackable	POST /trackables	Create a trackable.
TrackablesApi	delete_all_trackables	DELETE /trackables	Delete all trackables.
TrackablesApi	delete_trackable_by_id	DELETE /trackables/{trackable_id}	Delete a trackable.
TrackablesApi	get_all_trackable_ids	GET /trackables	Get an array of all trackable ids.
TrackablesApi	get_all_trackable_locations	GET /trackables/{trackable_id}/locations	Get all locations.
TrackablesApi	get_all_trackable_motions	GET /trackables/motions	Get an array of all trackable motion objects.
TrackablesApi	get_all_trackable_objects	GET /trackables/summary	Get an array of all trackables.
TrackablesApi	get_all_trackable_sensors	GET /trackables/{trackable_id}/sensors	Get an array of sensor objects.
TrackablesApi	get_inside_fence_for_trackable	GET /trackables/{trackable_id}/fences	Get all fences the trackable is within.
TrackablesApi	get_most_significant_trackable_location	GET /trackables/{trackable_id}/location	Get a location.
TrackablesApi	get_providers_of_trackable	GET /trackables/{trackable_id}/providers	Get location providers of a trackable
TrackablesApi	get_trackable_by_id	GET /trackables/{trackable_id}	Get a trackable.
TrackablesApi	get_trackable_motion	GET /trackables/{trackable_id}/motion	Get a motion.
TrackablesApi	update_trackable_by_id	PUT /trackables/{trackable_id}	Updates a trackable.
WebSocketApi	websocket_pub_sub	PUT /ws/socket	WebSocket publish/subscribe channel.
ZonesApi	create_fence_from_zone	GET /zones/{zone_id}/createfence	Create a fence object from a zone.
ZonesApi	create_zone	POST /zones	Create a zone.
ZonesApi	delete_all_zones	DELETE /zones	Delete all zones.
ZonesApi	delete_zone_by_id	DELETE /zones/{zone_id}	Delete a zone.
ZonesApi	get_all_zone_objects	GET /zones/summary	Get an array of all zones.
ZonesApi	get_zone_by_id	GET /zones/{zone_id}	Get a zone.
ZonesApi	get_zone_ids	GET /zones	Get an array of all zone ids.
ZonesApi	transform_by_zone_id	PUT /zones/{zone_id}/transform	Transform a position based on a zone.
ZonesApi	update_zone_by_id	PUT /zones/{zone_id}	Update a zone.

Documentation For Models

• Collision
• CollisionEvent
• CollisionEventCollisionArea
• Error
• Fence
• FenceEvent
• FenceRegion
• LineString
• LocatingRule
• Location
• LocationProvider
• Point
• Polygon
• Proximity
• RuleSetInner
• SimpleTransform
• Trackable
• TrackableMotion
• WebsocketError
• WebsocketMessage
• WebsocketSubscriptionRequest
• WebsocketSubscriptionResponse
• Zone

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication (JWT)

Author

info@omlox.com