ThingSmartDpParser.h

Go to the documentation of this file.

//
//  ThingSmartDpParser.h
//  ThingSmartDeviceCoreKit
//
//  Copyright (c) 2014-2024.
//
 
#import <Foundation/Foundation.h>
 
NS_ASSUME_NONNULL_BEGIN
 
@class ThingSmartDp;
@class ThingSmartSwitchDp;
 
@protocol ThingSmartDpDataSourceProtocol <NSObject>
@property (nonatomic, strong, readonly) NSDictionary<NSString *, id> *dps; // Mapping of dpId to current dpValue
@property (nonatomic, strong, readonly) NSArray<ThingSmartSchemaModel *> *schemaArray; //All DP schema
@property (nonatomic, assign, readonly) BOOL switchDpsValue; // Current value of switch DP
@property (nonatomic, strong, readonly) NSArray<NSNumber *> * switchDps; // A dpId list of switch DP
@property (nonatomic, strong, readonly) NSArray<NSNumber *> * displayDps;// A dpId list of display DP
@property (nonatomic, strong, readonly) NSArray<NSNumber *> * quickOpDps;// A dpId list of quick operate DP
@property (nonatomic, strong, readonly) NSDictionary<NSString *, NSString *> *dpName; // Mapping of dpId to title
@property (nonatomic, strong, readonly) NSDictionary<NSString *, NSString *> * displayMsgs;// Mapping of dp code to show content
@property (nonatomic, strong, readonly) NSString * schemaExt; // A json string of shcema additional information
@property (nonatomic, strong, readonly) ThingSmartStandSchemaModel *standSchemaModel;
@end
 
@interface ThingSmartDpParser : NSObject
+ (instancetype)createWithTargetInfo:(id)targetInfo;
@property (nonatomic, strong, readonly) id<ThingSmartDpDataSourceProtocol> dpDataSource;
 
@property (nonatomic, strong, readonly) NSArray<__kindof ThingSmartDp *> * displayDp;
@property (nonatomic, strong, readonly) NSArray<__kindof ThingSmartDp *> * operableDp;
@property (nonatomic, strong, readonly) NSArray<__kindof ThingSmartDp *> * allDp;
@property (nonatomic, strong, nullable, readonly) ThingSmartSwitchDp * switchDp;
@property (nonatomic, strong, nullable, readonly) NSArray<NSString *> * standardDpCodes;
 
- (nullable __kindof ThingSmartDp *)smartDpWithDpId:(NSInteger)dpId quickOp:(BOOL)quickOp;
+ (NSArray<__kindof ThingSmartDp *> *)smartDpListWithDpDataSource:(id<ThingSmartDpDataSourceProtocol>)dpDataSource
                                                              dps:(NSArray<NSNumber *> *)dps
                                                          quickOp:(BOOL)quickOp;
@end
 
typedef NS_ENUM(NSInteger, ThingSmartDpType) {
    ThingSmartDpType_Bool,
    ThingSmartDpType_Enum,
    ThingSmartDpType_Num,
    ThingSmartDpType_Light,
    ThingSmartDpType_String,
};
 
@interface ThingSmartDpValueDisplay : NSObject
@property (nonatomic, strong, readonly) ThingSmartDp * smartDp;
@property (nonatomic, strong, readonly) id dpValue;
 
@property (nonatomic, strong, nullable, readonly) NSString * displayValue;
@property (nonatomic, strong, nullable, readonly) NSString * displayUnit;
 
- (NSString *)dpValueDisplayStr;
@end
 
@interface ThingSmartDp : NSObject
+ (nullable __kindof ThingSmartDp *)smartDpWithTargetInfo:(id)targetInfo
                                                     dpId:(NSInteger)dpId
                                                  quickOp:(BOOL)quickOp;
+ (NSArray<__kindof ThingSmartDp *> *)smartDpListWithTargetInfo:(id)targetInfo
                                                            dps:(NSArray<NSNumber *> *)dps
                                                        quickOp:(BOOL)quickOp;
 
 
@property (nonatomic, strong, readonly) id<ThingSmartDpDataSourceProtocol> dpDataSource;
 
@property (nonatomic, strong, readonly) ThingSmartSchemaModel * schemaModel;
@property (nonatomic, assign, readonly) ThingSmartDpType smartDpType;
@property (nonatomic, strong, readonly) NSString * standardDpCode;//标准code
@property (nonatomic, strong, readonly) NSString * strategyCode;
 
@property (nonatomic, assign, readonly) NSInteger dpId;
@property (nonatomic, strong, readonly) NSString * dpType;
@property (nonatomic, strong, readonly) NSString * name;
@property (nonatomic, strong, readonly) NSString * iconname;
@property (nonatomic, strong, readonly) NSString * unit;
 
@property (nonatomic, strong, readonly) id curDpValue;
 
@property (nonatomic, strong, readonly) NSString * titleStatus;
 
@property (nonatomic, strong, readonly) NSString * valueStatus;
 
- (nullable NSDictionary *)publishCommands:(id)newDpValue;
 
- (NSString *)valueStatusWithDpValue:(id)dpValue;
 
 
- (ThingSmartDpValueDisplay *)valueDisplayWithDpValue:(id)dpValue;
@end
 
@interface ThingSmartLightDp : ThingSmartDp
@property (nonatomic, assign, readonly) NSUInteger lightHueMin;
@property (nonatomic, assign, readonly) NSUInteger lightHueMax;
@property (nonatomic, assign, readonly) NSUInteger currentLightHue;
- (NSString *)lightHueDsecLocalizedKey:(NSUInteger)lightHue;
 
@property (nonatomic, assign, readonly) NSUInteger lightSaturationMin;
@property (nonatomic, assign, readonly) NSUInteger lightSaturationMax;
@property (nonatomic, assign, readonly) NSUInteger currentLightSaturatio;
 
@property (nonatomic, assign, readonly) NSUInteger lightValueMin;
@property (nonatomic, assign, readonly) NSUInteger lightValueMax;
@property (nonatomic, assign, readonly) NSUInteger currentLightValue;
 
@property (nonatomic, assign, readonly) BOOL v2Type;
 
- (nullable NSDictionary *)publishCommandsWithLightHue:(NSUInteger)lightHue
                                       lightSaturation:(NSUInteger)lightSaturation
                                            lightValue:(NSUInteger)lightValue;
@end
 
 
@interface ThingSmartSwitchDp : NSObject
@property (nonatomic, assign, readonly) BOOL switchStatus;
 
@property (nonatomic, assign, readonly) BOOL writeOnlySwitch;
 
- (nullable NSDictionary *)publishSwitchCommands:(BOOL)open;
@end
NS_ASSUME_NONNULL_END