Skip to main content

Fluss+ API Client

Project description

Fluss API Client

A Python client for the Fluss REST API — control gates, doors, and access devices programmatically.

Installation

pip install fluss_api

Usage

import asyncio
from fluss_api import FlussApiClient

async def main():
    client = FlussApiClient(api_key="your-api-key")

    # List all devices
    devices = await client.async_get_devices()

    # Get device status
    status = await client.async_get_device_status("device-id")

    # Trigger a device
    await client.async_trigger_device("device-id")

    # Trigger with optional parameters
    await client.async_trigger_device("device-id", action="pulse", duration=3)

    # Open a device
    await client.async_open_device("device-id")

    # Close a device
    await client.async_close_device("device-id")

    await client.close()

asyncio.run(main())

Custom Session

You can pass your own aiohttp.ClientSession if needed:

from aiohttp import ClientSession
from fluss_api import FlussApiClient

async with ClientSession() as session:
    client = FlussApiClient(api_key="your-api-key", session=session)
    devices = await client.async_get_devices()

API Methods

Method Description
async_get_devices() List all devices on your account
async_get_device_status(device_id) Get current status of a device
async_trigger_device(device_id, **kwargs) Trigger a device
async_open_device(device_id, **kwargs) Open a gate/door
async_close_device(device_id, **kwargs) Close a gate/door
close() Close the HTTP session

Building from Source

python -m pip install --upgrade build
python -m build

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fluss_api-0.2.4.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fluss_api-0.2.4-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file fluss_api-0.2.4.tar.gz.

File metadata

  • Download URL: fluss_api-0.2.4.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fluss_api-0.2.4.tar.gz
Algorithm Hash digest
SHA256 350f0201ee62caf4e1d29aab4ca2b90ba854c879eb28efd4c878972529d96c8c
MD5 51c3b2de47b8e5c884c0756a66a52425
BLAKE2b-256 3273f63761ed9d871d97d4b0cd0c2ed0355860efe2ce7626d2a3d7210320c965

See more details on using hashes here.

Provenance

The following attestation bundles were made for fluss_api-0.2.4.tar.gz:

Publisher: python-publish.yml on fluss/Fluss_Python_Library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fluss_api-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: fluss_api-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fluss_api-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3e0de872ffce5675fd5f5209b0979c3c08cd549b3d85092e4bbc7e48b5c7a4d8
MD5 16c547dd9d287babbf17ba22b5617c4b
BLAKE2b-256 e4afc90028f2ec03d51c4ab4df24f74d37214ad922a98405489bdeb80f7d0f12

See more details on using hashes here.

Provenance

The following attestation bundles were made for fluss_api-0.2.4-py3-none-any.whl:

Publisher: python-publish.yml on fluss/Fluss_Python_Library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page