翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# 低レベルの C 機能 APIs
が提供する低レベルの C 機能 APIs。このセクションでは、デバイスとクラウド間の効率的なやり取りのために、 AWS データモデル内の各クラスターで使用できる API オペレーションについて説明します。コールバック関数の実装、イベントの出力、属性の変更の通知、デバイスエンドポイントのクラスターの登録を行う方法について説明します。
**主な API コンポーネントは次のとおりです。**
1. 属性とコマンドのコールバック関数ポインタ構造
1. イベント放出関数
1. 属性変更通知関数
1. クラスター登録関数
これらの APIs を実装することで、デバイスの物理オペレーションとマネージド統合のクラウド機能の間にブリッジを作成し、シームレスな通信と制御を確保できます。
次のセクションでは、[OnOffクラスター](https://github.com/project-chip/connectedhomeip/blob/v1.3.0.0/data_model/clusters/OnOff.xml) API について説明します。
## OnOff クラスター API
[https://github.com/project-chip/connectedhomeip/blob/5bb5c9e23d532cea40476fc0bd1d3008522792ba/data_model/clusters/OnOff.xml](https://github.com/project-chip/connectedhomeip/blob/5bb5c9e23d532cea40476fc0bd1d3008522792ba/data_model/clusters/OnOff.xml) クラスターは、次の属性とコマンドをサポートしています: 。
+ 属性:
+ `OnOff (boolean)`
+ `GlobalSceneControl (boolean)`
+ `OnTime (int16u)`
+ `OffWaitTime (int16u)`
+ `StartUpOnOff (StartUpOnOffEnum)`
+ コマンド:
+ `Off : () -> Status`
+ `On : () -> Status`
+ `Toggle : () -> Status`
+ `OffWithEffect : (EffectIdentifier: EffectIdentifierEnum, EffectVariant: enum8) -> Status`
+ `OnWithRecallGlobalScene : () -> Status`
+ `OnWithTimedOff : (OnOffControl: OnOffControlBitmap, OnTime: int16u, OffWaitTime: int16u) -> Status`
コマンドごとに、実装をフックするために使用できる 1:1 マッピングされた関数ポインタを提供します。
属性とコマンドのすべてのコールバックは、クラスターにちなんだ という名前の C 構造体内で定義されます。
### C 構造体の例
```
struct iotmiDev_clusterOnOff
{
/*
- Each attribute has a getter callback if it's readable
- Each attribute has a setter callback if it's writable
- The type of `value` are derived according to the data type of
the attribute.
- `user` is the pointer passed during an endpoint setup
- The callback should return iotmiDev_DMStatus to report success or not.
- For unsupported attributes, just leave them as NULL.
*/
iotmiDev_DMStatus (*getOnTime)(uint16_t *value, void *user);
iotmiDev_DMStatus (*setOnTime)(uint16_t value, void *user);
/*
- Each command has a command callback
- If a command takes parameters, the parameters will be defined in a struct
such as `iotmiDev_OnOff_OnWithTimedOffRequest` below.
- `user` is the pointer passed during an endpoint setup
- The callback should return iotmiDev_DMStatus to report success or not.
- For unsupported commands, just leave them as NULL.
*/
iotmiDev_DMStatus (*cmdOff)(void *user);
iotmiDev_DMStatus (*cmdOnWithTimedOff)(const iotmiDev_OnOff_OnWithTimedOffRequest *request, void *user);
};
```
C 構造体に加えて、属性変更レポート関数はすべての属性に定義されます。
```
/* Each attribute has a report function for the customer to report
an attribute change. An attribute report function is thread-safe.
*/
void iotmiDev_OnOff_OnTime_report_attr(struct iotmiDev_Endpoint *endpoint, uint16_t newValue, bool immediate);
```
イベントレポート関数は、すべてのクラスター固有のイベントに対して定義されます。OnOff クラスターはイベントを定義しないため、`CameraAvStreamManagement`クラスターの例を以下に示します。
```
/* Each event has a report function for the customer to report
an event. An event report function is thread-safe.
The iotmiDev_CameraAvStreamManagement_VideoStreamChangedEvent struct is
derived from the event definition in the cluster.
*/
void iotmiDev_CameraAvStreamManagement_VideoStreamChanged_report_event(struct iotmiDev_Endpoint *endpoint, const iotmiDev_CameraAvStreamManagement_VideoStreamChangedEvent *event, bool immediate);
```
各クラスターには登録関数もあります。
```
iotmiDev_DMStatus iotmiDev_OnOffRegisterCluster(struct iotmiDev_Endpoint *endpoint, const struct iotmiDev_clusterOnOff *cluster, void *user);
```
登録関数に渡されるユーザーポインタは、コールバック関数に渡されます。