1
0

value-codec.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. const {
  2. normalizeTextValue
  3. } = require('../../utils/base-utils.js')
  4. const {
  5. bytesToWords,
  6. formatHexNumber,
  7. wordsToBytes
  8. } = require('../../utils/binary-utils.js')
  9. const {
  10. alignEvenByteLength,
  11. getBitFieldByteLength,
  12. getBitFieldMaxValue,
  13. getDataType,
  14. getDataTypeIndex,
  15. getEncodeByteLimit,
  16. getRegisterByteLength,
  17. getRegisterTextByteLength,
  18. getRegisterValueTypeLabel,
  19. getRegisterWordCount,
  20. getRegisterWordCountAtOffset,
  21. isBitFieldRegister,
  22. isBitRegisterType,
  23. isByteRegister,
  24. isHexRegister,
  25. isNumericRegister,
  26. isRawRegister,
  27. isTextRegister,
  28. normalizeBitOffset,
  29. normalizeBitWidth,
  30. normalizeTextByteLength,
  31. supportsRange,
  32. supportsUnit
  33. } = require('./value-types.js')
  34. const {
  35. decodeTextBytes,
  36. encodeTextBytes
  37. } = require('./value-text.js')
  38. const {
  39. bytesToFloatValue,
  40. bytesToSignedInteger,
  41. bytesToUnsignedInteger,
  42. floatToBytes,
  43. formatFloatValue,
  44. formatHexValue,
  45. formatIntegerValue,
  46. parseNumberText,
  47. unsignedIntegerToBytes,
  48. validateNumericValue
  49. } = require('./value-number.js')
  50. function formatRawWordText(words = []) {
  51. if (!Array.isArray(words) || !words.length) return '--'
  52. return words.map((word) => `0x${formatHexNumber(word, 4)}`).join(' ')
  53. }
  54. function formatRawByteText(bytes = []) {
  55. if (!Array.isArray(bytes) || !bytes.length) return '--'
  56. return bytes.map((byte) => `0x${formatHexNumber(Number(byte) & 0xFF, 2)}`).join(' ')
  57. }
  58. function formatRawByteTextWithDefault(bytes = [], byteLength = 1) {
  59. const safeLength = Math.max(1, Math.floor(Number(byteLength) || 1))
  60. const source = Array.isArray(bytes) ? bytes : []
  61. return Array.from({ length: safeLength }, (_, index) => (
  62. `0x${formatHexNumber(Number(source[index] || 0) & 0xFF, 2)}`
  63. )).join(' ')
  64. }
  65. function parseCoilValue(value) {
  66. const text = String(value === undefined || value === null ? '' : value).trim()
  67. if (!text || text === '--') return null
  68. if (['1', 'true', 'TRUE', 'on', 'ON', '开'].includes(text)) return 1
  69. if (['0', 'false', 'FALSE', 'off', 'OFF', '关'].includes(text)) return 0
  70. const coilValue = Number(text)
  71. return Number.isFinite(coilValue) ? (coilValue ? 1 : 0) : null
  72. }
  73. function normalizeEnumOptions(register = {}) {
  74. return (Array.isArray(register.enumOptions) ? register.enumOptions : [])
  75. .map((option) => ({
  76. label: String(option && (option.label || option.name) || '').trim(),
  77. name: String(option && (option.name || option.label) || '').trim(),
  78. value: Number(option && option.value)
  79. }))
  80. .filter((option) => option.label && Number.isFinite(option.value))
  81. }
  82. function findEnumOptionByText(register, valueText) {
  83. const text = normalizeTextValue(valueText).trim()
  84. if (!text) return null
  85. const normalizedText = text.toLowerCase()
  86. return normalizeEnumOptions(register).find((option) => (
  87. option.name.toLowerCase() === normalizedText
  88. || option.label.toLowerCase() === normalizedText
  89. || `${option.label}(${option.value})`.toLowerCase() === normalizedText
  90. || `${option.label} (${option.value})`.toLowerCase() === normalizedText
  91. || `${option.label}(${option.value})`.toLowerCase() === normalizedText
  92. )) || null
  93. }
  94. function parseEnumValueText(register, valueText) {
  95. const option = findEnumOptionByText(register, valueText)
  96. return option ? option.value : null
  97. }
  98. function formatEnumValue(register, rawValue) {
  99. const numberValue = Number(rawValue)
  100. if (!Number.isFinite(numberValue)) return ''
  101. const option = normalizeEnumOptions(register).find((item) => Number(item.value) === numberValue)
  102. if (!option) return ''
  103. return `${option.label} (${numberValue})`
  104. }
  105. function parseBitFieldValue(register, valueText) {
  106. const text = normalizeTextValue(valueText).trim()
  107. const bitWidth = normalizeBitWidth(register.bitWidth)
  108. let parsed = parseEnumValueText(register, text)
  109. if (parsed === null) parsed = parseNumberText(text, 'uint32_t')
  110. const maxValue = getBitFieldMaxValue(register)
  111. if (parsed === null && bitWidth === 1) parsed = parseCoilValue(text)
  112. if (parsed === null) return null
  113. if (Math.round(parsed) !== parsed || parsed < 0 || parsed > maxValue) {
  114. throw new Error(`${register.name || '位域'} 超出 0 - ${maxValue} 范围`)
  115. }
  116. return Math.round(parsed)
  117. }
  118. function decodeBitFieldBytes(register, bytes = []) {
  119. const bitOffset = normalizeBitOffset(register.bitOffset)
  120. const bitWidth = normalizeBitWidth(register.bitWidth)
  121. let byteIndex = 0
  122. let currentBitOffset = bitOffset
  123. let multiplier = 1
  124. let remaining = bitWidth
  125. let value = 0
  126. while (remaining > 0 && byteIndex < bytes.length) {
  127. const take = Math.min(8 - currentBitOffset, remaining)
  128. const mask = (1 << take) - 1
  129. const part = ((Number(bytes[byteIndex]) & 0xFF) >> currentBitOffset) & mask
  130. value += part * multiplier
  131. multiplier *= Math.pow(2, take)
  132. remaining -= take
  133. byteIndex += 1
  134. currentBitOffset = 0
  135. }
  136. return remaining > 0 ? null : value
  137. }
  138. function encodeBitFieldIntoBytes(register, bytes, byteStart = 0) {
  139. const valueText = normalizeTextValue(register.inputValue)
  140. let value = parseBitFieldValue(register, valueText)
  141. const bitOffset = normalizeBitOffset(register.bitOffset)
  142. const bitWidth = normalizeBitWidth(register.bitWidth)
  143. let byteIndex = Math.max(0, Math.floor(Number(byteStart) || 0))
  144. let currentBitOffset = bitOffset
  145. let remaining = bitWidth
  146. if (value === null) return null
  147. while (remaining > 0) {
  148. const take = Math.min(8 - currentBitOffset, remaining)
  149. const mask = (1 << take) - 1
  150. const shiftedMask = (mask << currentBitOffset) & 0xFF
  151. const part = value & mask
  152. if (byteIndex >= bytes.length) return null
  153. bytes[byteIndex] = ((Number(bytes[byteIndex]) & 0xFF) & (~shiftedMask & 0xFF))
  154. | ((part << currentBitOffset) & shiftedMask)
  155. value = Math.floor(value / Math.pow(2, take))
  156. remaining -= take
  157. byteIndex += 1
  158. currentBitOffset = 0
  159. }
  160. return bytes
  161. }
  162. function encodeBitFieldBytes(register) {
  163. const bytes = Array.from({ length: getBitFieldByteLength(register) }, () => 0)
  164. return encodeBitFieldIntoBytes(register, bytes, 0)
  165. }
  166. function getRegisterDataBytes(register, words) {
  167. const dataType = getDataType(register.dataType).key
  168. const byteLength = getRegisterByteLength(dataType, register)
  169. const byteOffset = Math.max(0, Math.floor(Number(register.byteOffset) || 0))
  170. const sourceBytes = wordsToBytes(words, Math.max(0, (Array.isArray(words) ? words.length : 0) * 2))
  171. return sourceBytes.slice(byteOffset, byteOffset + byteLength)
  172. }
  173. function encodeRegisterBytes(register) {
  174. const dataType = getDataType(register.dataType).key
  175. const valueText = normalizeTextValue(register.inputValue)
  176. const byteLength = getRegisterByteLength(dataType, register)
  177. const memoryEndian = register.memoryEndian || 'big'
  178. if (isBitFieldRegister(register)) {
  179. return encodeBitFieldBytes(register)
  180. }
  181. if (isTextRegister(dataType)) {
  182. const byteLimit = getEncodeByteLimit(register)
  183. const bytes = encodeTextBytes(valueText, dataType, byteLimit)
  184. const paddedBytes = bytes.slice()
  185. while (paddedBytes.length < byteLength) {
  186. paddedBytes.push(0)
  187. }
  188. return paddedBytes.slice(0, byteLength)
  189. }
  190. if (isRawRegister(dataType)) return null
  191. let numberValue = parseEnumValueText(register, valueText)
  192. if (numberValue === null) numberValue = parseNumberText(valueText, dataType)
  193. if (numberValue === null) return null
  194. validateNumericValue(register, numberValue)
  195. if (dataType === 'float') return floatToBytes(numberValue, memoryEndian)
  196. const rounded = Math.round(numberValue)
  197. if (dataType === 'int8_t' || dataType === 'uint8_t') return [rounded & 0xFF]
  198. if (dataType === 'int16_t' || dataType === 'uint16_t' || dataType === 'hex') {
  199. return unsignedIntegerToBytes(rounded, 2, memoryEndian)
  200. }
  201. if (dataType === 'int32_t' || dataType === 'uint32_t') {
  202. return unsignedIntegerToBytes(rounded, 4, memoryEndian)
  203. }
  204. return unsignedIntegerToBytes(rounded, byteLength, memoryEndian)
  205. }
  206. function encodeRegisterWords(register) {
  207. const dataType = getDataType(register.dataType).key
  208. const bytes = encodeRegisterBytes(register)
  209. if (!Array.isArray(bytes)) return null
  210. if (isByteRegister(dataType)) return [bytes[0] & 0xFF]
  211. return bytesToWords(bytes.length % 2 === 0 ? bytes : bytes.concat(0))
  212. }
  213. function decodeRegisterValue(register, words) {
  214. const dataType = getDataType(register.dataType).key
  215. const memoryEndian = register.memoryEndian || 'big'
  216. if (!Array.isArray(words) || words.length < getRegisterWordCountAtOffset(dataType, register.byteOffset || 0, register)) return null
  217. const bytes = getRegisterDataBytes(register, words)
  218. const byteLength = getRegisterByteLength(dataType, register)
  219. if (bytes.length < byteLength) return null
  220. if (isBitFieldRegister(register)) {
  221. return decodeBitFieldBytes(register, bytes)
  222. }
  223. if (isTextRegister(dataType)) {
  224. return decodeTextBytes(bytes.slice(0, getEncodeByteLimit(register)), dataType)
  225. }
  226. if (isRawRegister(dataType)) {
  227. return bytes.slice(0, byteLength)
  228. }
  229. if (dataType === 'float') {
  230. return bytesToFloatValue(bytes, memoryEndian)
  231. }
  232. if (dataType === 'int8_t') {
  233. const byteValue = bytes[0] & 0xFF
  234. return byteValue & 0x80 ? byteValue - 0x100 : byteValue
  235. }
  236. if (dataType === 'uint8_t') {
  237. return bytes[0] & 0xFF
  238. }
  239. if (dataType === 'int16_t') {
  240. return bytesToSignedInteger(bytes.slice(0, 2), memoryEndian)
  241. }
  242. if (dataType === 'uint16_t') {
  243. return bytesToUnsignedInteger(bytes.slice(0, 2), memoryEndian)
  244. }
  245. if (dataType === 'hex') {
  246. return bytesToUnsignedInteger(bytes.slice(0, 2), memoryEndian)
  247. }
  248. if (dataType === 'int32_t') {
  249. return bytesToSignedInteger(bytes.slice(0, 4), memoryEndian)
  250. }
  251. return bytesToUnsignedInteger(bytes.slice(0, 4), memoryEndian)
  252. }
  253. function formatRegisterValue(register, rawValue) {
  254. if (rawValue === null || rawValue === undefined) return '--'
  255. const dataType = getDataType(register.dataType).key
  256. if (isRawRegister(dataType)) return formatRawByteText(Array.isArray(rawValue) ? rawValue : [])
  257. const enumValue = formatEnumValue(register, rawValue)
  258. if (enumValue) return enumValue
  259. if (isTextRegister(dataType)) return normalizeTextValue(rawValue)
  260. if (dataType === 'hex') return formatHexValue(rawValue)
  261. if (dataType === 'float') return formatFloatValue(rawValue)
  262. return formatIntegerValue(rawValue, dataType)
  263. }
  264. function formatCoilDisplayValue(value) {
  265. return Number(value) ? '1' : '0'
  266. }
  267. function registerTypeIsBit(register) {
  268. return !!register && isBitRegisterType(register.registerType)
  269. }
  270. function validateRegisterValue(register, value) {
  271. const valueText = normalizeTextValue(
  272. value === undefined || value === null ? '' : value
  273. ).trim()
  274. if (!valueText || valueText === '--') return true
  275. if (registerTypeIsBit(register)) {
  276. if (parseCoilValue(valueText) === null) {
  277. throw new Error(`${register.name || '线圈'} 只能填写 0 或 1`)
  278. }
  279. return true
  280. }
  281. if (isBitFieldRegister(register)) {
  282. if (parseBitFieldValue(register, valueText) === null) {
  283. throw new Error(`${register.name || '位域'} 输入值无效`)
  284. }
  285. return true
  286. }
  287. const dataType = getDataType(register.dataType).key
  288. if (isRawRegister(dataType)) {
  289. throw new Error(`${register.name || '寄存器'} 需要先配置数据类型`)
  290. }
  291. if (isTextRegister(dataType)) {
  292. encodeTextBytes(valueText, dataType, getEncodeByteLimit(register))
  293. return true
  294. }
  295. let numberValue = parseEnumValueText(register, valueText)
  296. if (numberValue === null) numberValue = parseNumberText(valueText, dataType)
  297. if (numberValue === null) {
  298. throw new Error(`${register.name || '寄存器'} 输入值无效`)
  299. }
  300. return validateNumericValue(register, numberValue)
  301. }
  302. module.exports = {
  303. alignEvenByteLength,
  304. decodeRegisterValue,
  305. encodeBitFieldIntoBytes,
  306. encodeRegisterBytes,
  307. encodeRegisterWords,
  308. encodeTextBytes,
  309. formatCoilDisplayValue,
  310. formatRawByteText,
  311. formatRawByteTextWithDefault,
  312. formatRawWordText,
  313. formatRegisterValue,
  314. normalizeEnumOptions,
  315. parseEnumValueText,
  316. getBitFieldByteLength,
  317. getBitFieldMaxValue,
  318. getDataType,
  319. getDataTypeIndex,
  320. getEncodeByteLimit,
  321. getRegisterByteLength,
  322. getRegisterTextByteLength,
  323. getRegisterValueTypeLabel,
  324. getRegisterWordCount,
  325. getRegisterWordCountAtOffset,
  326. isBitFieldRegister,
  327. isBitRegisterType,
  328. isByteRegister,
  329. isHexRegister,
  330. isNumericRegister,
  331. isRawRegister,
  332. isTextRegister,
  333. normalizeBitOffset,
  334. normalizeBitWidth,
  335. normalizeTextByteLength,
  336. parseCoilValue,
  337. parseNumberText,
  338. registerTypeIsBit,
  339. supportsRange,
  340. supportsUnit,
  341. validateRegisterValue
  342. }