fastybird/shelly-connector

FastyBird IoT connector for Shelly devices

Fund package maintenance!
akadlec

Installs: 452

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Type:fastybird-connector

This package is auto-updated.

Last update: 2024-10-30 21:41:56 UTC


README

FastyBird

FastyBird IoT Shelly connector

Build Status Licence Code coverage Mutation testing

PHP Latest stable Downloads total PHPStan

What is Shelly connector?

Shelly connector is extension for FastyBird IoT ecosystem which is integrating Shelly devices.

Features:

  • Support for Shelly Gen1 and Gen2 devices, allowing users to connect and control a wide range of Shelly devices
  • Automated device discovery feature, which automatically detects and adds Shelly devices to the FastyBird ecosystem
  • Support for Shelly device authentication using a username and password, providing an extra layer of security for connected devices
  • Shelly Connector management for the FastyBird IoT devices module, allowing users to easily manage and monitor Shelly devices
  • Advanced device management features, such as controlling power status, measuring energy consumption, and reading sensor data
  • {JSON:API} schemas for full API access, providing a standardized and consistent way for developers to access and manipulate Shelly device data
  • Regular updates with new features and bug fixes, ensuring that the Shelly Connector is always up-to-date and reliable.

Shelly Connector is a distributed extension that is developed in PHP, built on the Nette and Symfony frameworks, and is licensed under Apache2.

Requirements

Shelly connector is tested against PHP 8.2 and require installed Process Control PHP extension.

Installation

This extension is part of the FastyBird IoT ecosystem and is installed by default. In case you want to create you own distribution of FastyBird IoT ecosystem you could install this extension with Composer:

composer require fastybird/shelly-connector

Documentation

📖 Learn how to connect Shelly devices and manage them with FastyBird IoT system in documentation.

FastyBird

FastyBird

FastyBird is an Open Source IOT solution built from decoupled components with powerful API and the highest quality code. Read more on fastybird.com.com.

Documentation

📖 Documentation is available on docs.fastybird.com.

Contributing

The sources of this package are contained in the FastyBird monorepo. We welcome contributions for this package on FastyBird/fastybird.

Feedback

Use the issue tracker for bugs reporting or send an mail to us or you could reach us on X newtwork for any idea that can improve the project.

Thank you for testing, reporting and contributing.

Changelog

For release info check release page.

Maintainers

Homepage https://www.fastybird.com and repository https://github.com/fastybird/shelly-connector.