Skip to main content

A python client for Buffalo LinkStation

Project description

CI

LinkStation client

This project create for handling Buffalo LinkStation NAS with original firmware. It's originally created to integrate with Home Assistant to display the current status of NAS such as online status, disk spaces used, and have ability to perform restart from within home-assistant.

Usage

import asyncio
from linkstation import LinkStation

async def main() -> None:
    """Run!"""
    api = LinkStation("<LINKSTATION_ADMIN_USERNAME>","<LINKSTATION_ADMIN_PASSWORD>","<LINKSTATION_HOSTNAME/IP>")

    # List all disks
    disks = await api.get_all_disks_async()
    for disk in disks: 
        _LOGGER.debug(disk + ': ' + await api.get_disk_status_async(disk))

    active_disks = await api.get_active_disks_async()
    for disk in active_disks: 
        # Get disk capacity in GB
        diskCapacity = await api.get_disk_capacity_async(disk)
        
        # Get current used disk space in GB
        diskUsed = await api.get_disk_amount_used_async(disk)
        
        # Get current used disk space in percentage (provided by LinkStation)
        diskUsedPct = await api.get_disk_pct_used_async(disk)

asyncio.run(main())

Notes

All api testing based on Buffalo LinkStation Duo LS-WXL

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

linkstation-0.0.11.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

linkstation-0.0.11-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

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