invirtus/chirpstack3-api

Chirpstack 3 PHP API

dev-master 2024-11-19 14:54 UTC

Requires

• php: >=7.0.0
• google/protobuf: ^v4.27.1
• grpc/grpc: ^v1.57.0

Requires (Dev)

• protobuf-php/protobuf-plugin: ^0.1.3

Suggests

• ext-grpc: To make it all work

MIT

README

ChirpStack gRPC API message and service wrappers for PHP.

Install

With composer:

composer require chirpstack/chirpstack-api

Usage

All messages, services, constants, etc. are auto-generated from the ChirpStack protobuf definitions. The result is that this package structure matches that of the protobuf definitions.

The protobuf definitions can be found here: https://github.com/chirpstack/chirpstack/tree/master/api/proto

Example

<?php

namespace Test;

use Chirpstack\API\ApplicationServiceClient;
use Chirpstack\API\ListApplicationsRequest;
use Grpc\Channel;
use Grpc\ChannelCredentials;

require dirname(__FILE__) . '/vendor/autoload.php';

function main() {
    $channel = new Channel('url',  ['credentials' => ChannelCredentials::createInsecure()]);
    $client = new ApplicationServiceClient('url', [], $channel);
    $request = new ListApplicationsRequest();
    $response = $client->List($request);
    $data = $response->wait();
    print_r($data);
}

main();