wiliot-api is a python library for accessing Wiliot's cloud APIs from Python
pip install wiliot-api
Wiliot package location can be found, by typing in the command line:
pip show wiliot-api
Code examples for using PyWiliot-api (scroll down)
For more documentation and instructions, please contact us: support@wiliot.com
* Added a function for sending actions to a gateway
The package previous content was published under the name 'wiliot' package. for more information please read 'wiliot' package's release notes
# Import the library
from wiliot_api.platform.platform import *
import os
# Define an owner ID
owner_id = "test_owner1" # ToDo: add here your owner ID
# Initialise an Wiliot client object
platform = PlatformClient(api_key=os.environ.get("WILIOT_PLATFORM_API_KEY"), owner_id=owner_id)
# Get the first 50 pixels owned by the account
print(platform.get_pixels())
# Get a list of all pixels (not recommended on accounts with many pixels)
pixels = []
next_p = None
while True:
p, next_p = platform.get_pixels(next=next_p)
pixels += p
if next_p is None:
break
# Get a list of categories
platform.get_categories()
# Get a list of asset type
platform.get_asset_types()
# Create a category
platform.create_category(name="Black_box", asset_type_id='Default', category_id="black-box-sku",
description="A generic black box")
# Get a list of assets
platform.get_assets()
# Create an asset
platform.create_asset(name="Black-box-118763", category_id="black-box-sku",
tags=[{"tagId": "pixel-1-id", "role": TagRole.DEFAULT},
{"tagId": "pixel-2-id", "role": TagRole.DEFAULT}])
# Associate a pixel to an asset
platform.associate_pixel_to_asset("my-asset-id", pixel_id="pixel-id")
# Disassociate a pixel from an asset
platform.disassociate_pixel_from_asset(asset_id="my-asset-id", pixel_id="pixel-id")
# Replace pixels associated to an asset (disasociate and associate multiple pixels in a single call)
platform.update_pixel_to_asset_association(asset_id="my-asset-id", pixels_to_disassociate=["pixel-id-1", "pixel-id-2"],
pixels_to_associate=["pixel-id-3", "pixel-id-4"])
# Delete an asset
platform.delete_asset(asset_id="my-asset-id")
# Locations and zones
# Get a list of locations
platform.get_locations()
# Get a list of zones in a location
platform.get_zones(location_id="my-location-id")
# Associate a bridge to a zone
platform.create_zone_association(location_id="my-location-id", zone_id="my-zone-id",
association_type=ZoneAssociationType.BRIDGE, association_value="my-bridge-id")
# Labels (key:value pairs)
# Get a list of key:value pairs for an asset
platform.get_entity_keys_values(entity_type=EntityType.ASSET,
entity_id="my-asset-id")
# Supported entity types:
# * ASSET
# * LOCATION
# * ZONE
# * BRIDGE
# * GATEWAY
# Get a specific key:value for a zone
platform.get_entity_keys_values(entity_type=EntityType.ZONE,
entity_id="my-zone-id",
key="special_zone")
# Get all key values for a specific key and all bridges
platform.get_entity_type_keys_values(entity_type=EntityType.BRIDGE,
key='autoUpdate')
# Set one or more key:value pairs for one or more entities (of the same type)
platform.set_keys_values_for_entities(entity_type=EntityType.GATEWAY,
entity_ids=["gateway-id-1", "gateway-id-2"],
keys_values={"special_gateway": "True"})
# The previous call will fail if the provided gateways already have a value for a key called "special_gateway" set
# To force an overwrite of existing key value, use the overwrite_existing argument (False by default)
platform.set_keys_values_for_entities(entity_type=EntityType.GATEWAY,
entity_ids=["gateway-id-1", "gateway-id-2"],
keys_values={"special_gateway": "True"},
overwrite_existing=True)
# Delete key:value from one or more entities
platform.delete_entities_key_value(entity_type=EntityType.LOCATION,
entity_ids=["location-1-id", "location-2-id"],
key='special_zone')
# Import the library
from wiliot_api.edge.edge import *
import os
# Define an owner ID
owner_id = "test_owner" # ToDo: add here your owner ID
# Initialise an Wiliot edge client object
edge = EdgeClient(api_key=os.environ.get('WILIOT_EDGE_API_KEY'), owner_id=owner_id)
# Get a list of gateways owned by the owner
edge.get_gateways()
# Get details on a single gateway by its ID
edge.get_gateway(gateway_id="my-gateway-id")
# Update a gateway's configuration
# First get its current configuration
config = edge.get_gateway("my-gateway-id")["reportedConf"]
# Make the required change - for example, change the pacer interval
config["additional"]["pacerInterval"] = 15
# Update the gateway's configuration
edge.update_gateways_configuration(gateways=["my-gateway-id"], config=config)
# Register a new gateway
edge.register_gateway(gateways=["my-new-gateway-id"])
# Delete a gateway from the account (to move to another account, for example)
edge.delete_gateway(gateway_id="my-gateway-id")
# Bridges
# Get a list of all bridges registered under the account with their configuration
edge.get_bridges()
# Get a list of all online bridges
edge.get_bridges(online=True)
# Get a list of bridges connected to a certain gateway
edge.get_bridges(gateway_id="my-gateway-id")
# Claim a bridge - can be called for bridges connected to account gateways
# Once claimed, no other account can claim the same bridge
edge.claim_bridge(bridge_id="my-bridge-id")
# Unclaim (release) bridge from the account - making it available to claim by another account
edge.unclaim_bridge(bridge_id="my-bridge-id")
# Unclaim multiple bridges
edge.unclaim_bridges(bridge_ids=["bridge1-id", "bridge2-id"])
# Update a bridge configuration
# First, get its current configuration
config = edge.get_bridge(bridge_id="my-bridge-id")["config"]
# Get a list of bridge versions
edge.get_bridge_versions()
# Request the configuration change - single bridge
edge.update_bridge_configuration(bridge_id="my-bridge-id", config={'energyPattern': 63})
# Request the configuration change - multiple bridge
edge.update_bridges_configuration(bridge_ids=["bridge1-id", "bridge2-id"], config={'energyPattern': 63})
# Change a bridge's name
edge.update_bridge_configuration(bridge_id="my-bridge-id", name="my_bridge_name")
# Get any commands that have not finished or have been dismissed for a bridge
edge.get_bridge_non_dismissed_commands(bridge_id="bridge-id-1")
# Get bridges connected to gateway
edge.get_bridges_connected_to_gateway("gateway-id")
# Start a 5-minute debug survey
res = edge.start_survey(name="my-unique-survey-name", duration_ms=300000, bridges=["bridge-id-1", "bridge-id-2"])
# Read the results into a file
output_file_path = edge.get_survey_result(survey_id=res['id'], output_directory="/path/to/output/directory")
print(f"Debug survey results stored in {output_file_path}")
# Get information about all surveys in the past 30 days
surveys = edge.get_surveys()
# Stop a survey before it's finished
edge.stop_survey("survey-id")
# Import the library
from wiliot_api.manufacturing.manufacturing import *
import os
# Initialise an Wiliot client object
wiliot_manufacturing = ManufacturingClient(os.environ.get('WILIOT_MANUFACTURING_API_KEY'))
# Change the owner for a sequence of pixel IDs - useful for changing consecutive IDs - like part of a reel
req = wiliot_manufacturing.change_pixel_owner_by_range("first_pixel_id", "last_pixel_id", "from_owner_id",
"to_owner_id")
# Change the owner for a list of pixel IDs - When non-consecutive IDs need changing - up to 3000 pixels
req = wiliot_manufacturing.change_pixel_owner_by_list(["tag_1", "tag_2", "tag_3"], "from_owner_id", "to_owner_id")
# Change the owner of pixels by file - when needing to change more than 3000, non-consecutive IDs
#
# The file should be formatted as follows:
# tagId
# tag_1_id
# tag_2_id
# .....
req = wiliot_manufacturing.change_pixel_owner_by_file("from_owner_id", "to_owner_id", "/path/to/file")
# Each of the functions above returns a string representing a request ID. To check on the status of the request
print(wiliot_manufacturing.get_pixel_change_request_status(req))
FAQs
A library for interacting with Wiliot's private Cloud API
We found that wiliot-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.