value-codec.js 12 KB

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