1. Extension Features

Camera SDK provide some extension functions base on data point (DP). If you do not know about data point, please refer to Custom Device Control.

Class and Protocol

1.1. Device Control

1.1.1. Create instance

Declaration

Initialize data point manager.

- (instancetype)initWithDeviceId:(NSString *)devId;

Parameters

Declaration

Add and remove device status listening observer.

/// add observer
- (void)addObserver:(id<TuyaSmartCameraDPObserver>)observer;

/// remove observer
- (void)removeObserver:(id<TuyaSmartCameraDPObserver>)observer;

Parameters

1.1.2. Query value

Declaration

Determines whether the device supports a data point.

- (BOOL)isSupportDP:(TuyaSmartCameraDPKey)dpName;

Parameters

Return

Declaration

Query the value of the data point, get the value in the cache directly, and return nil if the data point is not supported.

- (id)valueForDP:(TuyaSmartCameraDPKey)dpName;

Parameters

Return

Declaration

Asynchronous query data point value, in addition to memory card related functions, is not recommended.

- (void)valueForDP:(TuyaSmartCameraDPKey)dpName success:(TYSuccessID)success failure:(TYFailureError)failure;

Parameters

1.1.3. Publish data

Declaration

Asynchronous set value for the specified data point.

- (void)setValue:(id)value forDP:(TuyaSmartCameraDPKey)dpName success:(TYSuccessID)success failure:(TYFailureError)failure;

Parameters

Except for some data points in the memory card state, the camera will voluntarily report to the cloud when the data point state changes, and the SDK will update the device's data point status cache in real time. Therefore, in most cases, it is ok to directly obtain the value of the data point in the cache.

Asynchronous query data point value, is publish NULL to the device, under normal circumstances, the device received NULL for the data point, will respond the value of the specified data point. However, this behavior is implemented by camera manufacturers, some manufacturers do not handle this logic, so after publish NULL, the camera firmware will crash. So when using this interface, make sure that the vendor has the logic to handle NULL correctly for these data points.

1.1.4. Callback

The TuyaSmartCameraDPObserver protocol provides the ability to monitor changes in the status of data points reported by the device.

Declaration

Device data point status change callback.

- (void)cameraDPDidUpdate: (TuyaSmartCameraDPManager *) manager dps: (NSDictionary *) dpsData;

Parameters

1.2. Data point id

Has open standard of camera data point, in the form of a string constants defined in TuyaSmartCameraDPManager.h, redefine as TuyaSmartCameraDPKey. The constant name is formed in the form of "TuyaSmartCamera"+"function"+"DPName".

1.2.1. Basic features

1.2.2. Motion detection alarm

1.2.3. Sound detection alarm

1.2.4. Memory card management

The value of SDCardStorageis a string which composed of total capacity, used capacity, free capacity by joined '|', the unit is kb. For example: "16777216|1048576|15728640" means that the total capacity is 16Gb, 1Gb has been used, and 15Gb is free.

1.2.5. PTZ control

1.2.6. Doorbell

1.2.7. Enum data points

The value range of the data point of the string enum type, there are corresponding string enumeration constants defined in the SDK. The memory card status is an integer enum. You can view the specific definition in TuyaSmartCameraDPManager.h.

Example

ObjC

- (void)viewDidLoad {
    [super viewDidLoad];
    self.dpManager = [[TuyaSmartCameraDPManager alloc] initWithDeviceId:self.devId];
      [self.dpManager addObserver:self];
      self.osdSwitch = [[self.dpManager valueForDP:TuyaSmartCameraBasicOSDDPName] boolValue];
}

- (void)openOSD {
    // Determine if the device supports this data point
    if ([self.dpManager isSupportDP:TuyaSmartCameraBasicOSDDPName]) {
        [self.dpManager setValue:@(YES) forDP:TuyaSmartCameraBasicOSDDPName success:^(id result) {
              self.osdSwitch = [result boolValue];
        } failure:^(NSError *error) {
                        // network error
        }];
    }
}

#pragma mark - TuyaSmartCameraDPObserver
- (void)cameraDPDidUpdate:(TuyaSmartCameraDPManager *)manager dps:(NSDictionary *)dpsData {
    // If the data points of the change includes time watermark switch
    if ([dpsData objectForKey:TuyaSmartCameraBasicOSDDPName]) {
        self.osdSwitch = [[dpsData objectForKey:TuyaSmartCameraBasicOSDDPName] boolValue];
    }
}

Swift

override func viewDidLoad() {
    super.viewDidLoad()
    self.dpManager = TuyaSmartCameraDPManager(deviceId: self.devId)
    self.dpManager.addObserver(self)
    if self.dpManager.isSupportDP(.basicOSDDPName) {
        self.osdSwitch = self.dpManager.value(forDP: .basicOSDDPName) as! Bool
    }
}

func openOSD() {
    // Determine if the device supports this data point
    guard self.dpManager.isSupportDP(.basicOSDDPName) else {
        return
    }
    self.dpManager.setValue(true, forDP: .basicOSDDPName, success: { result in
        self.osdSwitch = result as! Bool
    }) { _ in
                // network error
    }
}

func cameraDPDidUpdate(_ manager: TuyaSmartCameraDPManager!, dps dpsData: [AnyHashable : Any]!) {
    // If the data points of the change includes time watermark switch
    if let osdValue = dpsData[TuyaSmartCameraDPKey.basicOSDDPName] {
        self.osdSwitch = osdValue as! Bool
    }
}