|
| 1 | +package modbus |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | +) |
| 6 | + |
| 7 | +type fieldDefinition struct { |
| 8 | + Measurement string `toml:"measurement"` |
| 9 | + Name string `toml:"name"` |
| 10 | + ByteOrder string `toml:"byte_order"` |
| 11 | + DataType string `toml:"data_type"` |
| 12 | + Scale float64 `toml:"scale"` |
| 13 | + Address []uint16 `toml:"address"` |
| 14 | +} |
| 15 | + |
| 16 | +type ConfigurationOriginal struct { |
| 17 | + SlaveID byte `toml:"slave_id"` |
| 18 | + DiscreteInputs []fieldDefinition `toml:"discrete_inputs"` |
| 19 | + Coils []fieldDefinition `toml:"coils"` |
| 20 | + HoldingRegisters []fieldDefinition `toml:"holding_registers"` |
| 21 | + InputRegisters []fieldDefinition `toml:"input_registers"` |
| 22 | +} |
| 23 | + |
| 24 | +func (c *ConfigurationOriginal) Process() (map[byte]requestSet, error) { |
| 25 | + coil, err := c.initRequests(c.Coils, cCoils, maxQuantityCoils) |
| 26 | + if err != nil { |
| 27 | + return nil, err |
| 28 | + } |
| 29 | + |
| 30 | + discrete, err := c.initRequests(c.DiscreteInputs, cDiscreteInputs, maxQuantityDiscreteInput) |
| 31 | + if err != nil { |
| 32 | + return nil, err |
| 33 | + } |
| 34 | + |
| 35 | + holding, err := c.initRequests(c.HoldingRegisters, cHoldingRegisters, maxQuantityHoldingRegisters) |
| 36 | + if err != nil { |
| 37 | + return nil, err |
| 38 | + } |
| 39 | + |
| 40 | + input, err := c.initRequests(c.InputRegisters, cInputRegisters, maxQuantityInputRegisters) |
| 41 | + if err != nil { |
| 42 | + return nil, err |
| 43 | + } |
| 44 | + |
| 45 | + return map[byte]requestSet{ |
| 46 | + c.SlaveID: { |
| 47 | + coil: coil, |
| 48 | + discrete: discrete, |
| 49 | + holding: holding, |
| 50 | + input: input, |
| 51 | + }, |
| 52 | + }, nil |
| 53 | +} |
| 54 | + |
| 55 | +func (c *ConfigurationOriginal) Check() error { |
| 56 | + if err := c.validateFieldDefinitions(c.DiscreteInputs, cDiscreteInputs); err != nil { |
| 57 | + return err |
| 58 | + } |
| 59 | + |
| 60 | + if err := c.validateFieldDefinitions(c.Coils, cCoils); err != nil { |
| 61 | + return err |
| 62 | + } |
| 63 | + |
| 64 | + if err := c.validateFieldDefinitions(c.HoldingRegisters, cHoldingRegisters); err != nil { |
| 65 | + return err |
| 66 | + } |
| 67 | + |
| 68 | + return c.validateFieldDefinitions(c.InputRegisters, cInputRegisters) |
| 69 | +} |
| 70 | + |
| 71 | +func (c *ConfigurationOriginal) initRequests(fieldDefs []fieldDefinition, registerType string, maxQuantity uint16) ([]request, error) { |
| 72 | + fields, err := c.initFields(fieldDefs) |
| 73 | + if err != nil { |
| 74 | + return nil, err |
| 75 | + } |
| 76 | + return newRequestsFromFields(fields, c.SlaveID, registerType, maxQuantity), nil |
| 77 | +} |
| 78 | + |
| 79 | +func (c *ConfigurationOriginal) initFields(fieldDefs []fieldDefinition) ([]field, error) { |
| 80 | + // Construct the fields from the field definitions |
| 81 | + fields := make([]field, 0, len(fieldDefs)) |
| 82 | + for _, def := range fieldDefs { |
| 83 | + f, err := c.newFieldFromDefinition(def) |
| 84 | + if err != nil { |
| 85 | + return nil, fmt.Errorf("initializing field %q failed: %v", def.Name, err) |
| 86 | + } |
| 87 | + fields = append(fields, f) |
| 88 | + } |
| 89 | + |
| 90 | + return fields, nil |
| 91 | +} |
| 92 | + |
| 93 | +func (c *ConfigurationOriginal) newFieldFromDefinition(def fieldDefinition) (field, error) { |
| 94 | + // Check if the addresses are consecutive |
| 95 | + expected := def.Address[0] |
| 96 | + for _, current := range def.Address[1:] { |
| 97 | + expected++ |
| 98 | + if current != expected { |
| 99 | + return field{}, fmt.Errorf("addresses of field %q are not consecutive", def.Name) |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + // Initialize the field |
| 104 | + f := field{ |
| 105 | + measurement: def.Measurement, |
| 106 | + name: def.Name, |
| 107 | + scale: def.Scale, |
| 108 | + address: def.Address[0], |
| 109 | + length: uint16(len(def.Address)), |
| 110 | + } |
| 111 | + if def.DataType != "" { |
| 112 | + inType, err := c.normalizeInputDatatype(def.DataType, len(def.Address)) |
| 113 | + if err != nil { |
| 114 | + return f, err |
| 115 | + } |
| 116 | + outType, err := c.normalizeOutputDatatype(def.DataType) |
| 117 | + if err != nil { |
| 118 | + return f, err |
| 119 | + } |
| 120 | + byteOrder, err := c.normalizeByteOrder(def.ByteOrder) |
| 121 | + if err != nil { |
| 122 | + return f, err |
| 123 | + } |
| 124 | + |
| 125 | + f.converter, err = determineConverter(inType, byteOrder, outType, def.Scale) |
| 126 | + if err != nil { |
| 127 | + return f, err |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + return f, nil |
| 132 | +} |
| 133 | + |
| 134 | +func (c *ConfigurationOriginal) validateFieldDefinitions(fieldDefs []fieldDefinition, registerType string) error { |
| 135 | + nameEncountered := map[string]bool{} |
| 136 | + for _, item := range fieldDefs { |
| 137 | + //check empty name |
| 138 | + if item.Name == "" { |
| 139 | + return fmt.Errorf("empty name in '%s'", registerType) |
| 140 | + } |
| 141 | + |
| 142 | + //search name duplicate |
| 143 | + canonicalName := item.Measurement + "." + item.Name |
| 144 | + if nameEncountered[canonicalName] { |
| 145 | + return fmt.Errorf("name '%s' is duplicated in measurement '%s' '%s' - '%s'", item.Name, item.Measurement, registerType, item.Name) |
| 146 | + } |
| 147 | + nameEncountered[canonicalName] = true |
| 148 | + |
| 149 | + if registerType == cInputRegisters || registerType == cHoldingRegisters { |
| 150 | + // search byte order |
| 151 | + switch item.ByteOrder { |
| 152 | + case "AB", "BA", "ABCD", "CDAB", "BADC", "DCBA", "ABCDEFGH", "HGFEDCBA", "BADCFEHG", "GHEFCDAB": |
| 153 | + default: |
| 154 | + return fmt.Errorf("invalid byte order '%s' in '%s' - '%s'", item.ByteOrder, registerType, item.Name) |
| 155 | + } |
| 156 | + |
| 157 | + // search data type |
| 158 | + switch item.DataType { |
| 159 | + case "UINT16", "INT16", "UINT32", "INT32", "UINT64", "INT64", "FLOAT32-IEEE", "FLOAT64-IEEE", "FLOAT32", "FIXED", "UFIXED": |
| 160 | + default: |
| 161 | + return fmt.Errorf("invalid data type '%s' in '%s' - '%s'", item.DataType, registerType, item.Name) |
| 162 | + } |
| 163 | + |
| 164 | + // check scale |
| 165 | + if item.Scale == 0.0 { |
| 166 | + return fmt.Errorf("invalid scale '%f' in '%s' - '%s'", item.Scale, registerType, item.Name) |
| 167 | + } |
| 168 | + } |
| 169 | + |
| 170 | + // check address |
| 171 | + if len(item.Address) != 1 && len(item.Address) != 2 && len(item.Address) != 4 { |
| 172 | + return fmt.Errorf("invalid address '%v' length '%v' in '%s' - '%s'", item.Address, len(item.Address), registerType, item.Name) |
| 173 | + } |
| 174 | + |
| 175 | + if registerType == cInputRegisters || registerType == cHoldingRegisters { |
| 176 | + if 2*len(item.Address) != len(item.ByteOrder) { |
| 177 | + return fmt.Errorf("invalid byte order '%s' and address '%v' in '%s' - '%s'", item.ByteOrder, item.Address, registerType, item.Name) |
| 178 | + } |
| 179 | + |
| 180 | + // search duplicated |
| 181 | + if len(item.Address) > len(removeDuplicates(item.Address)) { |
| 182 | + return fmt.Errorf("duplicate address '%v' in '%s' - '%s'", item.Address, registerType, item.Name) |
| 183 | + } |
| 184 | + } else if len(item.Address) != 1 { |
| 185 | + return fmt.Errorf("invalid address'%v' length'%v' in '%s' - '%s'", item.Address, len(item.Address), registerType, item.Name) |
| 186 | + } |
| 187 | + } |
| 188 | + return nil |
| 189 | +} |
| 190 | + |
| 191 | +func (c *ConfigurationOriginal) normalizeInputDatatype(dataType string, words int) (string, error) { |
| 192 | + // Handle our special types |
| 193 | + switch dataType { |
| 194 | + case "FIXED": |
| 195 | + switch words { |
| 196 | + case 1: |
| 197 | + return "INT16", nil |
| 198 | + case 2: |
| 199 | + return "INT32", nil |
| 200 | + case 4: |
| 201 | + return "INT64", nil |
| 202 | + default: |
| 203 | + return "unknown", fmt.Errorf("invalid length %d for type %q", words, dataType) |
| 204 | + } |
| 205 | + case "FLOAT32", "UFIXED": |
| 206 | + switch words { |
| 207 | + case 1: |
| 208 | + return "UINT16", nil |
| 209 | + case 2: |
| 210 | + return "UINT32", nil |
| 211 | + case 4: |
| 212 | + return "UINT64", nil |
| 213 | + default: |
| 214 | + return "unknown", fmt.Errorf("invalid length %d for type %q", words, dataType) |
| 215 | + } |
| 216 | + case "FLOAT32-IEEE": |
| 217 | + return "FLOAT32", nil |
| 218 | + case "FLOAT64-IEEE": |
| 219 | + return "FLOAT64", nil |
| 220 | + } |
| 221 | + return normalizeInputDatatype(dataType) |
| 222 | +} |
| 223 | + |
| 224 | +func (c *ConfigurationOriginal) normalizeOutputDatatype(dataType string) (string, error) { |
| 225 | + // Handle our special types |
| 226 | + switch dataType { |
| 227 | + case "FIXED", "FLOAT32", "UFIXED": |
| 228 | + return "FLOAT64", nil |
| 229 | + } |
| 230 | + return normalizeOutputDatatype("native") |
| 231 | +} |
| 232 | + |
| 233 | +func (c *ConfigurationOriginal) normalizeByteOrder(byteOrder string) (string, error) { |
| 234 | + // Handle our special types |
| 235 | + switch byteOrder { |
| 236 | + case "AB", "ABCDEFGH": |
| 237 | + return "ABCD", nil |
| 238 | + case "BADCFEHG": |
| 239 | + return "BADC", nil |
| 240 | + case "GHEFCDAB": |
| 241 | + return "CDAB", nil |
| 242 | + case "BA", "HGFEDCBA": |
| 243 | + return "DCBA", nil |
| 244 | + } |
| 245 | + return normalizeByteOrder(byteOrder) |
| 246 | +} |
0 commit comments