forked from project-chip/zap
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make zap files smaller (project-chip#992)
* Add fileFormat to the file. * Add the cli logic. * Add both builtin metafiles as default and refresh matter test file. * Wrap up the type 1 format, keep default to 0. * Add unit test and trigger proper conversion. * Allow for injected key/value pairs. * Fix the reportable. * Fix the reportable change. * Fix a unit test. * Add name ordering. * Upgrade one matter file. * Convert an all-cluster matter file. * Convert some more files. * Add some more unit tests.
- Loading branch information
Showing
22 changed files
with
6,583 additions
and
27,430 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,310 @@ | ||
| /** | ||
| * | ||
| * Copyright (c) 2023 Silicon Labs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| const _ = require('lodash') | ||
| const types = require('../util/types') | ||
|
|
||
| // Converts attribute storage string to internal representation | ||
| function unpackAttribute(a) { | ||
| let data | ||
| if (a.includes('=>')) { | ||
| data = a.split('=>')[0] | ||
| } else { | ||
| data = a | ||
| } | ||
| let toks = data.split(' | ').map((x) => x.trim()) | ||
| if (toks.length != 12) throw new Error(`Invalid format: ${a}`) | ||
|
|
||
| let attr = {} | ||
| attr.included = toks[0] === '+' ? 1 : 0 | ||
| attr.code = types.hexStringToInt(toks[1]) | ||
| if (toks[2].length == 0) { | ||
| attr.mfgCode = null | ||
| } else { | ||
| attr.mfgCode = types.hexStringToInt(toks[2]) | ||
| } | ||
| attr.side = toks[3] | ||
| attr.storageOption = toks[4] === 'Ext' ? 'External' : toks[4] | ||
| attr.singleton = toks[5] === 'singleton' ? 1 : 0 | ||
| attr.bounded = toks[6] === 'bound' ? 1 : 0 | ||
| attr.defaultValue = toks[7] | ||
| attr.reportable = parseInt(toks[8]) | ||
| attr.minInterval = parseInt(toks[9]) | ||
| attr.maxInterval = parseInt(toks[10]) | ||
| attr.reportableChange = parseInt(toks[11]) | ||
| return attr | ||
| } | ||
|
|
||
| // Converts attribute object for internal representation. | ||
| function packAttribute(a) { | ||
| let data = [ | ||
| a.included === 1 ? '+' : '-', | ||
| types.intToHexString(a.code, 2), | ||
| a.mfgCode != null ? types.intToHexString(a.mfgCode, 2) : ' ', | ||
| a.side, | ||
| a.storageOption === 'External' ? 'Ext' : a.storageOption, | ||
| a.singleton ? 'singleton' : ' ', | ||
| a.bounded ? 'bound' : ' ', | ||
| a.defaultValue.padStart(20, ' '), | ||
| a.reportable, | ||
| a.minInterval, | ||
| a.maxInterval, | ||
| a.reportableChange, | ||
| ].join(' | ') | ||
| return `${data} => ${a.name} [${a.type}]` | ||
| } | ||
|
|
||
| // Converts command storage string to internal representation | ||
| function unpackCommand(c) { | ||
| let data | ||
| if (c.includes('=>')) { | ||
| data = c.split('=>')[0] | ||
| } else { | ||
| data = c | ||
| } | ||
| let toks = data.split(' | ').map((x) => x.trim()) | ||
| if (toks.length != 5) throw new Error(`Invalid format: ${a}`) | ||
|
|
||
| let cmd = {} | ||
| cmd.code = types.hexStringToInt(toks[0]) | ||
| if (toks[1].length == 0) { | ||
| cmd.mfgCode = null | ||
| } else { | ||
| cmd.mfgCode = types.hexStringToInt(toks[1]) | ||
| } | ||
| cmd.source = toks[2] | ||
| cmd.incoming = toks[3] === '1' ? 1 : 0 | ||
| cmd.outgoing = toks[4] === '1' ? 1 : 0 | ||
| return cmd | ||
| } | ||
|
|
||
| // Converts command object for file representation. | ||
| function packCommand(cmd) { | ||
| let data = [ | ||
| types.intToHexString(cmd.code, 2), | ||
| cmd.mfgCode != null ? types.intToHexString(cmd.mfgCode, 2) : ' ', | ||
| cmd.source, | ||
| cmd.incoming, | ||
| cmd.outgoing, | ||
| ].join(' | ') | ||
| return `${data} => ${cmd.name}` | ||
| } | ||
|
|
||
| // Convert string representation to internal object representation | ||
| function unpackEvent(ev) { | ||
| let data | ||
| if (ev.includes('=>')) { | ||
| data = ev.split('=>')[0] | ||
| } else { | ||
| data = ev | ||
| } | ||
| let toks = data.split(' | ').map((x) => x.trim()) | ||
| if (toks.length != 4) throw new Error(`Invalid format: ${a}`) | ||
|
|
||
| let evnt = {} | ||
| evnt.included = toks[0] === '+' ? 1 : 0 | ||
| evnt.code = types.hexStringToInt(toks[1]) | ||
| if (toks[2].length == 0) { | ||
| evnt.mfgCode = null | ||
| } else { | ||
| evnt.mfgCode = types.hexStringToInt(toks[2]) | ||
| } | ||
| evnt.side = toks[3] | ||
|
|
||
| return evnt | ||
| } | ||
|
|
||
| // Converts event object for file representation | ||
| function packEvent(ev) { | ||
| let data = [ | ||
| ev.included === 1 ? '+' : '-', | ||
| types.intToHexString(ev.code, 2), | ||
| ev.mfgCode != null ? types.intToHexString(ev.mfgCode, 2) : ' ', | ||
| ev.side, | ||
| ].join(' | ') | ||
| return `${data} => ${ev.name}` | ||
| } | ||
|
|
||
| // Converts the key value pairs in the file into internal representation | ||
| function unpackKeyValuePairs(keyValuePairs) { | ||
| let kvps = [] | ||
| for (let kvp of keyValuePairs) { | ||
| if (_.isString(kvp)) { | ||
| let pair = kvp.split('=').map((x) => x.trim()) | ||
| kvps.push({ | ||
| key: pair[0], | ||
| value: pair[1], | ||
| }) | ||
| } else { | ||
| kvps.push(kvp) | ||
| } | ||
| } | ||
| return kvps | ||
| } | ||
|
|
||
| // Packs key value pairs for extenrnal representation | ||
| function packKeyValuePairs(keyValuePairs) { | ||
| let props = [] | ||
| for (let kvp of keyValuePairs) { | ||
| props.push(`${kvp.key} = ${kvp.value}`) | ||
| } | ||
| return props | ||
| } | ||
|
|
||
| // Cleanses toplevel cluster data. | ||
| function cleanseCluster(c) { | ||
| c.code = '0x' + c.code.toString(16).padStart(4, '0') | ||
| if (c.mfgCode != null) { | ||
| c.mfgCode = '0x' + c.mfgCode.toString(16).padStart(4, '0') | ||
| } else { | ||
| delete c.mfgCode | ||
| } | ||
| } | ||
|
|
||
| // Uncleanses the toplevel cluster data. | ||
| function uncleanseCluster(c) { | ||
| if (_.isString(c.code)) { | ||
| let code = c.code | ||
| if (code.startsWith('0x')) code = code.substring(2) | ||
| c.code = parseInt(code, 16) | ||
| } | ||
|
|
||
| if (_.isString(c.mfgCode)) { | ||
| let code = c.mfgCode | ||
| if (code.startsWith('0x')) code = code.substring(2) | ||
| c.mfgCode = parseInt(code, 16) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This function gets the state from database and converts it for a given file format. | ||
| * | ||
| * @param {*} state | ||
| * @param {*} fileFormat | ||
| */ | ||
| function convertToFile(state) { | ||
| if (state.fileFormat && state.fileFormat > 0) { | ||
| // Convert key value pairs | ||
| if (state.keyValuePairs) { | ||
| state.keyValuePairs = packKeyValuePairs(state.keyValuePairs) | ||
| } | ||
|
|
||
| for (let ept of state.endpointTypes) { | ||
| // Now cleanse the clusters | ||
| for (let c of ept.clusters) { | ||
| cleanseCluster(c) | ||
| } | ||
|
|
||
| for (let c of ept.clusters) { | ||
| // Now we convert all the attributes... | ||
| if (c.attributes) { | ||
| let atts = [] | ||
| for (let a of c.attributes) { | ||
| atts.push(packAttribute(a)) | ||
| } | ||
| c.attributes = atts | ||
| } | ||
|
|
||
| // ... and commands... | ||
| if (c.commands) { | ||
| let cmds = [] | ||
| for (let cmd of c.commands) { | ||
| cmds.push(packCommand(cmd)) | ||
| } | ||
| c.commands = cmds | ||
| } | ||
|
|
||
| // ... and events. | ||
| if (c.events) { | ||
| let evs = [] | ||
| for (let ev of c.events) { | ||
| evs.push(packEvent(ev)) | ||
| } | ||
| c.events = evs | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return state | ||
| } else { | ||
| return state | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This function gets the JSON from the file, and converts it to the correct database state | ||
| */ | ||
| function convertFromFile(state) { | ||
| if (state.fileFormat && state.fileFormat > 0) { | ||
| // Convert key value pairs | ||
| if (state.keyValuePairs) { | ||
| state.keyValuePairs = unpackKeyValuePairs(state.keyValuePairs) | ||
| } | ||
|
|
||
| for (let ept of state.endpointTypes) { | ||
| // Now uncleanse the clusters | ||
| for (let c of ept.clusters) { | ||
| uncleanseCluster(c) | ||
|
|
||
| // Now we convert all the attributes... | ||
| if (c.attributes) { | ||
| let atts = [] | ||
| for (let a of c.attributes) { | ||
| if (_.isString(a)) { | ||
| atts.push(unpackAttribute(a)) | ||
| } else { | ||
| atts.push(a) | ||
| } | ||
| } | ||
| c.attributes = atts | ||
| } | ||
|
|
||
| // ... and commands. | ||
| if (c.commands) { | ||
| let cmds = [] | ||
| for (let cmd of c.commands) { | ||
| if (_.isString(cmd)) { | ||
| cmds.push(unpackCommand(cmd)) | ||
| } else { | ||
| cmds.push(cmd) | ||
| } | ||
| } | ||
| c.commands = cmds | ||
| } | ||
|
|
||
| // ... and events. | ||
| if (c.events) { | ||
| let evs = [] | ||
| for (let ev of c.events) { | ||
| if (_.isString(ev)) { | ||
| evs.push(unpackEvent(ev)) | ||
| } else { | ||
| evs.push(ev) | ||
| } | ||
| } | ||
| c.events = evs | ||
| } | ||
| } | ||
| } | ||
| return state | ||
| } else { | ||
| return state | ||
| } | ||
| } | ||
|
|
||
| exports.convertFromFile = convertFromFile | ||
| exports.convertToFile = convertToFile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.