arimac / sigfox
一个高级、最新的Sigfox API客户端
2.0.2
2021-06-03 12:03 UTC
Requires
- php: >=7.1
Requires (Dev)
- phpunit/phpunit: ^9.5
- vimeo/psalm: 4.x-dev
Suggests
- guzzlehttp/guzzle: Required for using the builtin default HTTP client
Conflicts
- guzzlehttp/guzzle: <7.0
This package is not auto-updated.
Last update: 2024-09-20 03:58:44 UTC
README
PHP Sigfox 客户端
一个高级的、最新的Sigfox API客户端库,用于访问所有操作。
安装
$ composer require arimac/sigfox guzzlehttp/guzzle:7.*
如果您计划使用除了 guzzlehttp
之外的HTTP客户端,您不需要安装它。
用法
请参阅文档以获取详细描述。以下是一些代码片段,以帮助您了解该库。
- 初始化客户端
use Arimac\Sigfox\Sigfox; $sigfox = new Sigfox("myapikey", "password");
- 从服务器获取设备
$device = $sigfox->devices()->find("AF01F")->get();
- 更新设备
$sigfox->devices()->find("AF01F")->update(["deviceTypeId"=>"0f1bc092ef..."]);
- 创建设备
$sigfox->devices()->create([ "pac"=> "585CB3B42AC98BD4", "name"=> "Device 1", "deviceTypeId"=> "57309548171c857460043085", "id"=> "00FF" ]); // Or you can use objects to pass data $deviceId = $sigfox->devices()->create( (new DeviceCreationJob) ->setPac("585CB3B42AC98BD4") ->setId("00FF") ->setName("Device 1") ->setDeviceTypeId("57309548171c857460043085") );
- 删除设备
$sigfox->devices()->find("AF01F")->delete();
功能
- 实现了所有操作
- 能够使用用户定义的HTTP客户端。
- 根据API文档中的验证规则进行请求验证。
- 一个用于处理分页请求的开发者友好助手
- 一个用于处理异步请求的开发者友好助手
- 文件下载(kmz)
版本控制
初始版本代码是 2.0.0
。第一个数字(2
)属于Sigfox API的版本号。第二个数字随着主版本的变化而变化。第三个数字随着次版本的变化而变化。
问题和功能请求
如果您在使用此库时遇到任何问题或错误,请毫不犹豫地报告。我们有点忙,但很高兴为您提供帮助。
我们只为解决最常见任务添加了几个基本功能到此库。如果您有关于新功能的想法,请随时在 问题 部分告诉我们。
贡献
如果您想贡献但不知道从哪里开始,请访问 问题 部分,并尝试挑选一个问题。
如果您是第一次贡献,请阅读 贡献指南。然后,在 master
分支上创建一个PR,提交您的贡献。请确保所有贡献都具有向后兼容性。因为我们不会频繁发布此库的主要版本。