Skip to content

Commit

Permalink
feat: move voc related properties to modernExtend
Browse files Browse the repository at this point in the history
  • Loading branch information
@sjorge
sjorge committed Jun 29, 2024
1 parent 84c4680 commit 406888e
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 56 deletions.
61 changes: 5 additions & 56 deletions src/devices/develco.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,39 +130,6 @@ const develco = {
return result;
},
} satisfies Fz.Converter,
voc: {
cluster: 'manuSpecificDevelcoAirQuality',
type: ['attributeReport', 'readResponse'],
convert: (model, msg, publish, options, meta) => {
// from Sensirion_Gas_Sensors_SGP3x_TVOC_Concept.pdf
// "The mean molar mass of this mixture is 110 g/mol and hence,
// 1 ppb TVOC corresponds to 4.5 μg/m3."
const vocPpb = parseFloat(msg.data['measuredValue']);
const voc = vocPpb * 4.5;
const vocProperty = utils.postfixWithEndpointName('voc', msg, model, meta);

// from aqszb-110-technical-manual-air-quality-sensor-04-08-20.pdf page 6, section 2.2 voc
// this contains a ppb to level mapping table.
let airQuality;
const airQualityProperty = utils.postfixWithEndpointName('air_quality', msg, model, meta);
if (vocPpb <= 65) {
airQuality = 'excellent';
} else if (vocPpb <= 220) {
airQuality = 'good';
} else if (vocPpb <= 660) {
airQuality = 'moderate';
} else if (vocPpb <= 2200) {
airQuality = 'poor';
} else if (vocPpb <= 5500) {
airQuality = 'unhealthy';
} else if (vocPpb > 5500) {
airQuality = 'out_of_range';
} else {
airQuality = 'unknown';
}
return {[vocProperty]: voc, [airQualityProperty]: airQuality};
},
} satisfies Fz.Converter,
voc_battery: {
cluster: 'genPowerCfg',
type: ['attributeReport', 'readResponse'],
Expand Down Expand Up @@ -852,39 +819,21 @@ const definitions: Definition[] = [
model: 'AQSZB-110',
vendor: 'Develco',
description: 'Air quality sensor',
fromZigbee: [develco.fz.voc, develco.fz.voc_battery, develco.fz.temperature, fz.humidity],
fromZigbee: [develco.fz.voc_battery, develco.fz.temperature, fz.humidity],
toZigbee: [],
ota: ota.zigbeeOTA,
exposes: [
e.voc(),
e.temperature(),
e.humidity(),
e.battery(),
e.battery_low(),
e
.enum('air_quality', ea.STATE, ['excellent', 'good', 'moderate', 'poor', 'unhealthy', 'out_of_range', 'unknown'])
.withDescription('Measured air quality'),
],
exposes: [e.temperature(), e.humidity(), e.battery(), e.battery_low()],
extend: [
develcoModernExtend.addCustomClusterManuSpecificDevelcoGenBasic(),
develcoModernExtend.addCustomClusterManuSpecificDevelcoAirQuality(),
develcoModernExtend.readGenBasicPrimaryVersions(),
develcoModernExtend.voc(),
develcoModernExtend.airQuality(),
],
extend: [develcoModernExtend.addCustomClusterManuSpecificDevelcoAirQuality()],
meta: {battery: {voltageToPercentage: '3V_2500'}},
configure: async (device, coordinatorEndpoint) => {
const endpoint = device.getEndpoint(38);
await reporting.bind(endpoint, coordinatorEndpoint, [
'manuSpecificDevelcoAirQuality',
'msTemperatureMeasurement',
'msRelativeHumidity',
'genPowerCfg',
]);
await endpoint.configureReporting(
'manuSpecificDevelcoAirQuality',
[{attribute: 'measuredValue', minimumReportInterval: 60, maximumReportInterval: 3600, reportableChange: 10}],
manufacturerOptions,
);
await reporting.bind(endpoint, coordinatorEndpoint, ['msTemperatureMeasurement', 'msRelativeHumidity', 'genPowerCfg']);
await reporting.temperature(endpoint, {min: constants.repInterval.MINUTE, max: constants.repInterval.MINUTES_10, change: 10});
await reporting.humidity(endpoint, {min: constants.repInterval.MINUTE, max: constants.repInterval.MINUTES_10, change: 300});
await reporting.batteryVoltage(endpoint, {min: constants.repInterval.HOUR, max: 43200, change: 100});
Expand Down
62 changes: 62 additions & 0 deletions src/lib/develco.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,66 @@ export const develcoModernExtend = {
];
return {configure, isModernExtend: true};
},
voc: (args?: Partial<NumericArgs>) =>
numeric({
name: 'voc',
cluster: 'manuSpecificDevelcoAirQuality',
attribute: 'measuredValue',
reporting: {min: '1_MINUTE', max: '1_HOUR', change: 10},
description: 'Measured VOC value',
// from Sensirion_Gas_Sensors_SGP3x_TVOC_Concept.pdf
// "The mean molar mass of this mixture is 110 g/mol and hence,
// 1 ppb TVOC corresponds to 4.5 μg/m3."
scale: 4.5,
unit: 'µg/m³',
access: 'STATE_GET',
...args,
}),
airQuality: (): ModernExtend => {
// NOTE: do not setup reporting, this is hanled by the voc() modernExtend

const clusterName = 'manuSpecificDevelcoAirQuality';
const attributeName = 'measuredValue';
const propertyName = 'air_quality';
const access = ea.STATE_GET;

const expose = e
.enum('air_quality', ea.STATE, ['excellent', 'good', 'moderate', 'poor', 'unhealthy', 'out_of_range', 'unknown'])
.withDescription('Measured air quality');

const fromZigbee: Fz.Converter[] = [
{
cluster: clusterName,
type: ['attributeReport', 'readResponse'],
convert: (model, msg, publish, options, meta) => {
if (msg.data.hasOwnProperty(attributeName)) {
const vocPpb = parseFloat(msg.data[attributeName]);

// from aqszb-110-technical-manual-air-quality-sensor-04-08-20.pdf page 6, section 2.2 voc
// this contains a ppb to level mapping table.
let airQuality;
if (vocPpb <= 65) {
airQuality = 'excellent';
} else if (vocPpb <= 220) {
airQuality = 'good';
} else if (vocPpb <= 660) {
airQuality = 'moderate';
} else if (vocPpb <= 2200) {
airQuality = 'poor';
} else if (vocPpb <= 5500) {
airQuality = 'unhealthy';
} else if (vocPpb > 5500) {
airQuality = 'out_of_range';
} else {
airQuality = 'unknown';
}

return {[propertyName]: airQuality};
}
},
},
];

return {exposes: [expose], fromZigbee, isModernExtend: true};
},
};

0 comments on commit 406888e

Please sign in to comment.