README

AT&T的M2X PHP客户端

AT&T M2X 是一种基于云的、完全托管的时间序列数据存储服务，用于网络连接的机器到机器（M2M）设备和物联网（IoT）。

AT&T M2X API 提供所有必要的操作和方法，以便将您的设备连接到AT&T的M2X服务。这个库旨在为PHP提供一个简单的封装，以便与AT&T M2X API交互。请参阅术语表，以了解本文档中使用的命名法。

入门

1. 注册一个 M2X 账户。
2. 从您的账户设置屏幕的“主密钥”选项卡中获取您的主密钥。
3. 创建您的第一个设备并复制其设备ID。
4. 查看M2X API文档。

安装

如果您使用Composer管理项目的依赖项，只需将attm2x/m2x-php添加到您的项目composer.json文件中即可。

{
  "require": {
    "attm2x/m2x-php": "~4.0"
  }
}

用法

为了与M2X API通信，您需要一个M2X实例。您需要将API密钥传递给构造函数以访问您的数据。

use Att\M2X\M2X;

$m2x = new M2X("<YOUR-API-KEY>"");

这为您提供了M2X中的数据接口

• 分发

  $distribution = $m2x->distribution("<DISTRIBUTION-ID>");
  
  $distributions = $m2x->distributions();

• 设备

  $device = $m2x->device("<DEVICE-ID>");
  
  $devices = $m2x->devices();

• 密钥

  $key = $m2x->key("<KEY-TOKEN>");
  
  $keys = $m2x->keys();

请参阅每个类的文档以获取更多使用说明。

示例

为了运行此示例，您需要一个设备ID和API密钥。如果您没有，请访问您的M2X账户，创建一个新的设备，并复制设备ID和API密钥值。以下脚本将您的CPU负载平均值发送到三个不同的流中，分别命名为load_1m、load_5m和load_15。请检查是否需要创建流才能写入值。

要执行此脚本，请运行

API_KEY= DEVICE= php examples/uptime.php

use Att\M2X\M2X;
use Att\M2X\Error\M2XException;

$apiKey = getenv("API_KEY");
$deviceId  = getenv("DEVICE");

$m2x = new M2X($apiKey);

# Get the device
$device = $m2x->device($deviceId);

# Create the streams if they don't exist yet
$device->updateStream('load_1m');
$device->updateStream('load_5m');
$device->updateStream('load_15m');

while (true) {
  list($load_1m, $load_5m, $load_15m) = sys_getloadavg();
  $now = date('c');

  $values = array(
    'load_1m'  => array(array('value' => $load_1m,  'timestamp' => $now)),
    'load_5m'  => array(array('value' => $load_5m,  'timestamp' => $now)),
    'load_15m' => array(array('value' => $load_15m, 'timestamp' => $now))
  );

  try {
    $device->postUpdates($values);
  } catch (M2XException $ex) {
    echo 'Error: ' . $ex->getMessage();
    echo $ex->response->raw;
    break;
  }

  sleep(10);
}

版本控制

这个库旨在遵循语义化版本控制 2.0.0。简而言之，给定一个版本号MAJOR.MINOR.PATCH

1. MAJOR在客户端引入不兼容的更改时增加。
2. MINOR在添加向后兼容的功能时增加。
3. PATCH在添加向后兼容的bug修复时增加。

在MAJOR.MINOR.PATCH格式的基础上，还提供了预发布和构建元数据的附加标签。

注意：客户端版本不一定反映AT&T M2X API使用的版本。

许可证

此库在MIT许可证下提供。有关适用条款，请参阅LICENSE。