https://github.com/jalallinux/laravel-thingsboard

ThingsBoard laravel client
https://github.com/jalallinux/laravel-thingsboard

Last synced: about 1 month ago
JSON representation

ThingsBoard laravel client

• Host: GitHub
• URL: https://github.com/jalallinux/laravel-thingsboard
• Owner: jalallinux
• License: mit
• Created: 2023-05-20T08:12:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-15T16:04:24.000Z (9 months ago)
• Last Synced: 2024-04-15T17:28:04.547Z (9 months ago)
• Language: PHP
• Homepage:
• Size: 941 KB
• Stars: 31
• Watchers: 2
• Forks: 2
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-thingsboard - Laravel ThingsBoard.io Client - PHP Laravel client (SDKs and REST clients)

README

        
# Laravel [ThingsBoard.io](https://thingsboard.io/) Client

  

    
    



[![Latest Stable Version](https://poser.pugx.org/jalallinux/laravel-thingsboard/v)](https://packagist.org/packages/jalallinux/laravel-thingsboard)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/jalallinux/laravel-thingsboard.svg?style=flat-square)](https://packagist.org/packages/jalallinux/laravel-thingsboard)

[![Tests](https://github.com/jalallinux/laravel-thingsboard/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/jalallinux/laravel-thingsboard/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/jalallinux/laravel-thingsboard.svg?style=flat-square)](https://packagist.org/packages/jalallinux/laravel-thingsboard)

---

ThingsBoard is an open-source IoT platform for data collection, processing, visualization, and device management. This project is a Laravel Package that provides convenient client SDK for Integrate with Thingsboard APIs.

## Installation

You can install the package via composer

```bash

composer require jalallinux/laravel-thingsboard

```

## Publish config file

You can publish config file to change default configs

```bash

 php artisan vendor:publish --provider JalalLinuX\\Thingsboard\\LaravelThingsboardServiceProvider --tag config

```

## Publish language file

You can publish config file to change default languages

```bash

 php artisan vendor:publish --provider JalalLinuX\\Thingsboard\\LaravelThingsboardServiceProvider --tag lang

```

## Preparing for usage

`User` class must implement `JalalLinuX\Thingsboard\Interfaces\ThingsboardUser` like this:

```php

class User extends Authenticatable implements JalalLinuX\Thingsboard\Interfaces\ThingsboardUser

{

    public function getThingsboardEmailAttribute(): string

    {

        return $this->attributes['thingsboard_email'];

    }

    public function getThingsboardPasswordAttribute(): string

    {

        return $this->attributes['thingsboard_password'];

    }

    public function getThingsboardAuthorityAttribute(): EnumAuthority

    {

        return EnumAuthority::from($this->attributes['thingsboard_authority']);

    }

    

    ...

```

Then can use trait `JalalLinuX\Thingsboard\Traits\ThingsboardUser` like this:

```php

class User extends Authenticatable implements JalalLinuX\Thingsboard\Interfaces\ThingsboardUser

{

    use \JalalLinuX\Thingsboard\Traits\ThingsboardUser

    

    ...

}

```

## Usage with Tntity classes

```php

use JalalLinuX\Thingsboard\Entities\DeviceApi;

/** Without Authentication */

DeviceApi::instance()->setAttribute('deviceToken', 'A1_TEST_TOKEN')->postTelemetry([...])

/** With Authentication */

Device::instance()->withUser($tenantUser)->getDeviceById('ca3b8fc0-dcf6-11ed-a299-0f591673a2d6')

Device::instance()->withUser($tenantUser)->setAttribute('id', 'ca3b8fc0-dcf6-11ed-a299-0f591673a2d6')->getDeviceById()

Device::instance(['id' => 'ca3b8fc0-dcf6-11ed-a299-0f591673a2d6'])->withUser($tenantUser)->getDeviceById()

```

## Usage with Helper function

```php

/** Without Authentication */

thingsboard()->deviceApi()->setAttribute('deviceToken', 'A1_TEST_TOKEN')->postDeviceAttributes([...])

/** With Authentication */

thingsboard()->device()->withUser($tenantUser)->getDeviceById('ca3b8fc0-dcf6-11ed-a299-0f591673a2d6')

thingsboard($tenantUser)->device()->setAttribute('id', 'ca3b8fc0-dcf6-11ed-a299-0f591673a2d6')->getDeviceById()

thingsboard()->device(['id' => 'ca3b8fc0-dcf6-11ed-a299-0f591673a2d6'])->withUser($tenantUser)->getDeviceById()

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

- [JalalLinuX](https://github.com/jalallinux)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.