@fastybird/devices-module

Devices module data model plugin

Usage no npm install needed!

<script type="module">
  import fastybirdDevicesModule from 'https://cdn.skypack.dev/@fastybird/devices-module';
</script>

README

FastyBird IoT devices module

Build Status Licence Code coverage

PHP PHP latest stable PHP downloads total PHPStan

JS JS latest stable JS downloads total Types

Python Python latest stable Python downloads month Black MyPy

What is FastyBird IoT devices module?

Devices module is a combined Nette framework extension, Vuex ORM plugin and also Python module for managing connectors and connected devices and their basic logic.

FastyBird IoT devices module is an Apache2 licensed distributed extension, developed in PHP with Nette framework, in Typescript and also in Python.

Features:

  • Devices connectors management
  • Devices and channels management
  • Support for data exchange bus
  • {JSON:API} schemas for full api access
  • User access check & validation
  • Multilingual
  • JS integration via Vuex ORM plugin
  • Python integration via SQLAlchemy
  • Integrated connector worker for Python based connectors & PHP based connectors

Requirements

PHP part of FastyBird devices module is tested against PHP 7.4 and ReactPHP http 0.8 event-driven, streaming plaintext HTTP server and Nette framework 3.0 PHP framework for real programmers

JavaScript part of FastyBird devices module is tested against ECMAScript 6

Python part of FastyBird devices module is tested against Python 3.7

Installation

Application backend in PHP

The best way to install fastybird/devices-module is using Composer:

composer require fastybird/devices-module

Application frontend in JS

The best way to install @fastybird/devices-module is using Yarn:

yarn add @fastybird/devices-module

or if you prefer npm:

npm install @fastybird/devices-module

Application workers in Python

The best way to install fastybird-devices-module is using pip:

pip install fastybird-devices-module

Documentation

Learn how to use devices module and manage your connectors & devices in documentation.

Feedback

Use the issue tracker for bugs or mail or Tweet us for any idea that can improve the project.

Thank you for testing, reporting and contributing.

Changelog

For release info check release page

Maintainers


Adam Kadlec

Homepage https://www.fastybird.com and repository https://github.com/fastybird/devices-module.