1/*
2 * Copyright (c) 2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16#ifndef OHOS_HDI_LIGHT_V1_0_ILIGHTINTERFACE_H
17#define OHOS_HDI_LIGHT_V1_0_ILIGHTINTERFACE_H
18
19#include <stdint.h>
20#include <vector>
21#include <hdf_base.h>
22#include <hdi_base.h>
23#include "light/v1_0/light_types.h"
24
25#ifndef HDI_BUFF_MAX_SIZE
26#define HDI_BUFF_MAX_SIZE (1024 * 200)
27#endif
28
29#ifndef HDI_CHECK_VALUE_RETURN
30#define HDI_CHECK_VALUE_RETURN(lv, compare, rv, ret) do { \
31    if ((lv) compare (rv)) { \
32        return ret; \
33    } \
34} while (false)
35#endif
36
37#ifndef HDI_CHECK_VALUE_RET_GOTO
38#define HDI_CHECK_VALUE_RET_GOTO(lv, compare, rv, ret, value, table) do { \
39    if ((lv) compare (rv)) { \
40        ret = value; \
41        goto table; \
42    } \
43} while (false)
44#endif
45
46namespace OHOS {
47namespace HDI {
48namespace Light {
49namespace V1_0 {
50using namespace OHOS;
51using namespace OHOS::HDI;
52
53enum {
54    CMD_LIGHT_INTERFACE_GET_VERSION = 0,
55    CMD_LIGHT_INTERFACE_GET_LIGHT_INFO = 1,
56    CMD_LIGHT_INTERFACE_TURN_ON_LIGHT = 2,
57    CMD_LIGHT_INTERFACE_TURN_ON_MULTI_LIGHTS = 3,
58    CMD_LIGHT_INTERFACE_TURN_OFF_LIGHT = 4,
59};
60
61class ILightInterface : public HdiBase {
62public:
63    DECLARE_HDI_DESCRIPTOR(u"ohos.hdi.light.v1_0.ILightInterface");
64
65    virtual ~ILightInterface() = default;
66
67    static sptr<OHOS::HDI::Light::V1_0::ILightInterface> Get(bool isStub = false);
68    static sptr<OHOS::HDI::Light::V1_0::ILightInterface> Get(const std::string &serviceName, bool isStub = false);
69
70    virtual int32_t GetLightInfo(std::vector<OHOS::HDI::Light::V1_0::HdfLightInfo>& info) = 0;
71
72    virtual int32_t TurnOnLight(int32_t lightId, const OHOS::HDI::Light::V1_0::HdfLightEffect& effect) = 0;
73
74    virtual int32_t TurnOnMultiLights(int32_t lightId,
75         const std::vector<OHOS::HDI::Light::V1_0::HdfLightColor>& colors) = 0;
76
77    virtual int32_t TurnOffLight(int32_t lightId) = 0;
78
79    virtual int32_t GetVersion(uint32_t& majorVer, uint32_t& minorVer)
80    {
81        majorVer = 1;
82        minorVer = 0;
83        return HDF_SUCCESS;
84    }
85
86    virtual bool IsProxy()
87    {
88        return false;
89    }
90
91    virtual const std::u16string GetDesc()
92    {
93        return metaDescriptor_;
94    }
95};
96} // V1_0
97} // Light
98} // HDI
99} // OHOS
100
101#endif // OHOS_HDI_LIGHT_V1_0_ILIGHTINTERFACE_H
102
103