lzh06550107/julongdevice-sdk-php

JuLongDeviceApi php sdk

Maintainers

Details

github.com/lzh06550107/device-sdk

Homepage

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

dev-master 2022-05-24 06:38 UTC

Requires

Apache-2.0 bb46908325a26858ffe7d767a203a2f096d5b867

  • lzh <lzh08022040.woop@126.com>

This package is auto-updated.

Last update: 2024-04-24 11:00:23 UTC

README

对应 http-20211223 协议版本。

演示配置

需要设置 demo/server/ 为本地服务根目录。

index文件会处理设备发送过来的注册、心跳、抓拍请求。

完成的接口

设备接收请求

  • JVTPlatformReq：激活设备；

    方法一：

    <?php

use JuLongDeviceHttp\Basic\Models\JVTPlatform;
use JuLongDeviceHttp\Basic\Models\JVTPlatformRequest;
use JuLongDeviceHttp\Common\Exception\DeviceSDKException;
use JuLongDeviceHttp\Common\Profile\ClientProfile;
use JuLongDeviceHttp\Common\Profile\HttpProfile;
use JuLongDeviceHttp\HttpClient;

require_once '../../vendor/autoload.php';

HttpClient::configurator()->getHttpProfile()->setProtocol(HttpProfile::$REQ_HTTP)
    ->setEndpoint("128.128.20.131:8011")->setReqMethod(HttpProfile::$REQ_POST)
    ->setReqTimeout(30)
    ->back() // 从 HttpProfile 配置回到 HttpClientBuilder 对象继续配置
    ->getClientProfile()->setSignMethod(ClientProfile::$SIGN_MD5)->setUUID("umethqdt2gm9")
    ->setDeviceAdmin('admin')->setDevicePassword('admin');

try {

    $req = new JVTPlatformRequest();

    // 填充请求参数,这里request对象的成员变量即对应接口的入参
    $jVTPlatformReq = new JVTPlatform();
    $jVTPlatformReq->DomainName = "http://128.128.20.81"; // 如果是本地平台，这里是平台所在服务器地址；如果是云端平台，这里是中间件所在云服务器地址
    $jVTPlatformReq->Port = 80; // 注意端口也要修改
    $jVTPlatformReq->RegisterPath = "index.php?op=register";
    $jVTPlatformReq->HeartbeatPath = "index.php?op=online";
    $jVTPlatformReq->CaptureInfoPath = "index.php?op=compareInfo";
    $jVTPlatformReq->DeviceSN = "123456789";
    $jVTPlatformReq->DeviceAdmin = "admin";
    $jVTPlatformReq->DevicePassword = "admin";
    $jVTPlatformReq->MiddleWareAddress = "http://128.128.20.81";

    $req->Data = $jVTPlatformReq;

    // 通过client对象调用 JVTPlatform 方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个 JVTPlatformResponse 类的实例，与请求对象对应
    $resp = HttpClient::basicClient()->JVTPlatform($req);

    var_dump($resp);

    // 输出json格式的字符串回包
    print_r($resp->toJsonString());

    // 也可以取出单个值。
    // 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->Name);

} catch(DeviceSDKException $e) {
    echo $e;
}

    方法二：

    <?php

use JuLongDeviceHttp\Basic\BasicClient;
use JuLongDeviceHttp\Basic\Models\JVTPlatform;
use JuLongDeviceHttp\Basic\Models\JVTPlatformRequest;
use JuLongDeviceHttp\Common\Exception\DeviceSDKException;
use JuLongDeviceHttp\Common\Profile\ClientProfile;
use JuLongDeviceHttp\Common\Profile\HttpProfile;

require_once '../../vendor/autoload.php';

try {

    // 实例化一个http选项，可选的，没有特殊需求可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod(HttpProfile::$REQ_POST);  // post请求(默认为post请求)
    $httpProfile->setReqTimeout(30);    // 请求超时时间，单位为秒(默认60秒)
    $httpProfile->setEndpoint("128.128.20.131:8011");  // 指定接入设备地址
    $httpProfile->setProtocol(HttpProfile::$REQ_HTTP);

    // 实例化一个client选项，可选的，没有特殊需求可以跳过
    $clientProfile = new ClientProfile();
    // 这里使用md5签名验证，需要设备开启Sign验证
//    $clientProfile->setSignMethod(ClientProfile::$SIGN_MD5);  // 指定签名算法(默认为md5)
//    $clientProfile->setUUID("umethqdt2gm9");
//    $clientProfile->setDeviceAdmin("admin");
//    $clientProfile->setDevicePassword("admin");
    $clientProfile->setHttpProfile($httpProfile);

    // 实例化要请求client对象,clientProfile是可选的
    $client = new BasicClient($clientProfile);

    // 实例化一个请求对象,每个接口都会对应一个request对象。
    $req = new JVTPlatformRequest();

    // 填充请求参数,这里request对象的成员变量即对应接口的入参
    $jVTPlatformReq = new JVTPlatform();
    $jVTPlatformReq->DomainName = "http://128.128.20.81"; // 如果是本地平台，这里是平台所在服务器地址；如果是云端平台，这里是中间件所在云服务器地址
    $jVTPlatformReq->Port = 80; // 注意端口也要修改
    $jVTPlatformReq->RegisterPath = "index.php?op=register";
    $jVTPlatformReq->HeartbeatPath = "index.php?op=online";
    $jVTPlatformReq->CaptureInfoPath = "index.php?op=compareinfo";
    $jVTPlatformReq->DeviceSN = "123456789";
    $jVTPlatformReq->DeviceAdmin = "admin";
    $jVTPlatformReq->DevicePassword = "admin";
    $jVTPlatformReq->MiddleWareAddress = "http://128.128.20.81";

    $req->Data = $jVTPlatformReq;

    // 通过client对象调用 JVTPlatform 方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个 JVTPlatformResponse 类的实例，与请求对象对应
    $resp = $client->JVTPlatform($req);

    var_dump($resp);

    // 输出json格式的字符串回包
    print_r($resp->toJsonString());

    // 也可以取出单个值。
    // 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->Name);
} catch(DeviceSDKException $e) {
    echo $e;
}

  • eventNotifyRequest：主动获取任务请求

    <?php

use JuLongDeviceHttp\Basic\BasicClient;
use JuLongDeviceHttp\Basic\Models\EventNotifyRequest;
use JuLongDeviceHttp\Common\Exception\DeviceSDKException;
use JuLongDeviceHttp\Common\Profile\ClientProfile;
use JuLongDeviceHttp\Common\Profile\HttpProfile;

require_once '../../vendor/autoload.php';

try {
    // 实例化一个http选项，可选的，没有特殊需求可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod(HttpProfile::$REQ_POST);  // post请求(默认为post请求)
    $httpProfile->setReqTimeout(30);    // 请求超时时间，单位为秒(默认60秒)
    $httpProfile->setEndpoint("128.128.20.131:8011");  // 指定接入设备地址
    $httpProfile->setProtocol(HttpProfile::$REQ_HTTP);

    // 实例化一个client选项，可选的，没有特殊需求可以跳过
    $clientProfile = new ClientProfile();
    // 这里使用md5签名验证，需要设备开启Sign验证
//    $clientProfile->setSignMethod(ClientProfile::$SIGN_MD5);  // 指定签名算法(默认为md5)
//    $clientProfile->setUUID("umethqdt2gm9");
//    $clientProfile->setDeviceAdmin("admin");
//    $clientProfile->setDevicePassword("admin");
    $clientProfile->setHttpProfile($httpProfile);

    // 实例化要请求client对象,clientProfile是可选的
    $client = new BasicClient($clientProfile);

    // 实例化一个请求对象,每个接口都会对应一个request对象。
    $req = new EventNotifyRequest();
    $req->TimeStamp = time();
    // 需要设备开启注册
    $req->Session = 'fdjlsfjeowjfldsfa';


    // 通过client对象调用 eventNotify 方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个 eventNotifyResponse 类的实例，与请求对象对应
    $resp = $client->eventNotify($req);

    var_dump($resp);

    // 输出json格式的字符串回包
    print_r($resp->toJsonString());

    // 也可以取出单个值。
    // 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->getName());
}catch (DeviceSDKException $e) {
    echo $e;
}

  • deviceInfoRequest：获取设备信息

  • IOControlRequest：IO控制（远程开门）

  • timeSynchronizationRequest：时间同步

  • restartRequest：重启设备

  • restartTimeRequest：定时重启

  • restoreFactoryRequest：恢复出厂

  • upgradeDeviceRequest：升级设备

  • activeCaptureRequest：主动抓拍

云台控制

  • 未实现

参数获取和设置接口

  • getHTTPParametersRequest：HTTP参数获取
  • setHTTPParametersRequest：HTTP参数设置
  • getFaceParametersRequest：人脸识别参数获取
  • setFaceParametersRequest：设置人脸识别参数
  • getFaceAlarmParametersRequest：人脸识别报警参数获取
  • setFaceAlarmParametersRequest：人脸识别报警参数设置
  • getNetParametersRequest：网络参数获取
  • setNetParametersRequest：网络参数设置
  • getTimeParametersRequest：时间参数获取(NTP)
  • getTimeParametersRequest：时间参数设置(NTP)
  • getAudioParametersRequest：音频参数获取
  • setAudioParametersRequest：音频参数设置
  • getMQTTParametersRequest：MQTT参数获取
  • setMQTTParametersRequest：MQTT参数设置
  • getSIMCardRequest：SIM卡(4G/5G)参数获取
  • setSIMCardRequest：SIM卡(4G/5G)参数设置
  • setUserPasswordRequest：用户名密码设置
  • getGPSParametersRequest：GPS信息参数获取
  • setGPSParametersRequest：GPS参数设置

管理名单库接口

  • getPersonList：获取名单列表
  • getPerson：获取人员信息
  • addPerson：添加人员信息
  • editPerson：编辑人员信息
  • deletePerson：删除人员信息
  • deletePersonList：删除名单库(名单分组)
  • addPersons：批量添加人员
  • deletePersons：批量删除人员

人脸比对功能接口

  • historyRecordRequest：获取历史识别记录
  • deleteRecordRequest：删除历史识别记录
  • faceFeatureValueRequest：人脸图片获取特征值
  • faceSearchRequest：人脸搜索名单库
  • faceSimilarityRequest：人脸比较相似度
  • detectFaceRequest：图片检测人脸

通行策略管理接口

  • addStrategys：添加/修改通行策略
  • deleteStrategys：删除通行策略
  • getStrategys：查询通行策略
  • getIdentifyStrategys：获取人员分组关联通行策略
  • setIdentifyStrategys：设置人员分组关联通行策略
  • getPersonsByStrategy：获取通行策略绑定人员列表
  • personBindStrategys：人员绑定通行策略
  • personUnBindStrategys：人员解绑通行策略
  • identityChangeRequest：人员身份替换（人员换组）

NVR管理接口

  • searchVideoRequest：搜索录像列表（仅NVR支持）
  • searchPictureRequest：搜索图片列表（仅NVR支持）

广告和公告功能接口

未实现

管理门禁密码接口

  • addPasswords：批量添加密码
  • editPasswords：批量修改密码
  • deletePasswords：批量删除密码
  • getPasswords：批量查询密码

健康码信息接口

  • getHealthCodeRequest：获取健康码

分班播报管理接口

  • changeReportRequest：批量更改播报机编号

上传文件接口

  • searchVideoRecordRequest：搜索录像文件
  • fileUploadRequest：上传录像文件

注意

不同的框架请依赖不同的guzzle包：

  • composer require guzzlehttp/guzzle 兼容tp/laveral
  • composer require yurunsoft/guzzle-swoole 兼容基于swoole的框架