Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge develop into master #386

Merged
merged 5 commits into from
Apr 18, 2024
Merged

Merge develop into master #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63165b2
Merge pull request #382 from athombv/master
RobinBol Dec 7, 2023
e720eca
feat(matter): add matter driver validation
nozols Apr 17, 2024
8250198
feature(matter): update error strings
nozols Apr 18, 2024
8c81853
feature(matter): validate driver/device.mjs
nozols Apr 18, 2024
31c97b0
Merge pull request #385 from athombv/feature/matter-drivers
nozols Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 93 additions & 1 deletion assets/app/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,6 +747,94 @@
]
}
},
"matterDevice": {
"type": "object",
"required": ["vendorId", "productId"],
"properties": {
"vendorId": {
"oneOf": [
{
"type": "number",
"minimum": 1,
"maximum": 65520
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 1,
"maximum": 65520
}
}
]
},
"productId": {
"oneOf": [
{
"type": "number",
"minimum": 1,
"maximum": 65535
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 1,
"maximum": 65535
}
}
]
},
"deviceVendorId": {
"oneOf": [
{
"type": "number",
"minimum": 1,
"maximum": 65520
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 1,
"maximum": 65520
}
}
]
},
"deviceProductName": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 32
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
]
},
"learnmode": {
"type": "object",
"required": [
"instruction"
],
"properties": {
"image": {
"type": "string"
},
"instruction": {
"$ref": "#/definitions/i18nObject"
}
}
}
}
},
"zigbeeDevice": {
"type": "object",
"required": [
Expand Down Expand Up @@ -1322,6 +1410,9 @@
}
]
},
"matter": {
"$ref": "#/definitions/matterDevice"
},
"zwave": {
"$ref": "#/definitions/zwaveDevice"
},
Expand Down Expand Up @@ -1368,7 +1459,8 @@
"zigbee",
"infrared",
"rf433",
"rf868"
"rf868",
"matter"
]
}
}
Expand Down
39 changes: 37 additions & 2 deletions lib/App/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,9 @@ class App {
}

// validate `appJson.drivers[].connectivity`
if (driver.connectivity && (driver.connectivity.includes('lan') || driver.connectivity.includes('rf868'))) {
if (driver.connectivity && (driver.connectivity.includes('lan') || driver.connectivity.includes('rf868') || driver.connectivity.includes('matter'))) {
if (driver.platforms && driver.platforms.includes('cloud')) {
throw new Error(`drivers.${driver.id} invalid 'connectivity': Platform 'cloud' does not support 'lan' or 'rf868'.`);
throw new Error(`drivers.${driver.id} invalid 'connectivity': Platform 'cloud' does not support 'lan', 'matter' or 'rf868'.`);
}
}

Expand All @@ -365,6 +365,41 @@ class App {
});
}
}

if (driver.connectivity && driver.connectivity.includes('matter')) {
if (!driver.matter) {
throw new Error(`drivers.${driver.id} has 'connectivity': 'matter' and therefore requires a 'matter' object.`);
}

if (driver.pair) {
throw new Error(`drivers.${driver.id} invalid 'pair' configuration, Matter drivers do not support custom pairing views.`);
}

if (
(driver.matter.deviceVendorId === undefined && driver.matter.deviceProductName !== undefined) ||
(driver.matter.deviceVendorId !== undefined && driver.matter.deviceProductName === undefined)
) {
throw new Error(`drivers.${driver.id} invalid 'matter': 'deviceVendorId' and 'deviceProductName' must be defined together.`);
}

const deviceJsExists = await this._fileExistsCaseSensitive(join('drivers', driver.id, 'device.js'));
const deviceMjsExists = await this._fileExistsCaseSensitive(join('drivers', driver.id, 'device.mjs'));

if (deviceJsExists || deviceMjsExists) {
throw new Error(`drivers.${driver.id}: using a device.${deviceJsExists ? 'js' : 'mjs'} file is not supported for Matter drivers.`);
}

const driverJsExists = await this._fileExistsCaseSensitive(join('drivers', driver.id, 'driver.js'));
const driverMjsExists = await this._fileExistsCaseSensitive(join('drivers', driver.id, 'driver.mjs'));

if (driverJsExists || driverMjsExists) {
throw new Error(`drivers.${driver.id}: using a driver.${driverJsExists ? 'js' : 'mjs'} file is not supported for Matter drivers.`);
}
}

if (driver.matter && !(driver.connectivity && driver.connectivity.includes('matter'))) {
throw new Error(`drivers.${driver.id} Matter drivers require 'connectivity' to include 'matter'.`);
}
}
}

Expand Down
Loading