{
 "manufacturer": "Lochinvar",
 "manufacturer_slug": "lochinvar",
 "model": "Armor 1250-4000 commercial water heaters, Series 100 & 101 (Modbus communication board)",
 "model_slug": "armor-1250-4000-modbus",
 "short_model": "Armor 1250-4000",
 "aliases": [
  "Armor 1250",
  "Armor 1500",
  "Armor 2000",
  "Armor 2500",
  "Armor 3000",
  "Armor 3500",
  "Armor 4000",
  "AWH",
  "AWH1250",
  "AWH4000",
  "SMART SYSTEM"
 ],
 "equipment_type": "Boiler (commercial water heater)",
 "applies_to": "Lochinvar Armor water heaters, models 1250-4000, Series 100 and 101, with the SMART SYSTEM control and Modbus/BACnet communication board, per 100305786_2000558371 Rev C.",
 "summary": "The large Armor water heaters (1250-4000 MBH) use the SMART SYSTEM control and a Modbus RTU communication board on RS-485. The BAS can write a configuration word, an enable word, a rate or setpoint command and a remote tank temperature; it reads switch and flame states, outlet/inlet/flue temperatures, firing rate, cascade power and the status, blocking and lockout codes of the unit and its cascade members.",
 "transport": [
  "RTU"
 ],
 "defaults": {
  "unit_id": null,
  "baud": null,
  "parity": null,
  "data_bits": null,
  "stop_bits": null,
  "tcp_port": null
 },
 "addressing": {
  "convention": "Modicon",
  "note": "Addresses are printed Modicon-style (00001, 10001, 30001, 40001). Subtract the table base and 1 for the wire address; the manual's exception-code text confirms PDU addresses start at 0."
 },
 "default_word_order": null,
 "firmware": null,
 "source": {
  "title": "ModBus and BACnet Communication Instructions - Armor Models 1250-4000, Series 100 & 101",
  "doc_number": "100305786_2000558371 Rev C",
  "revision_date": null,
  "url": "https://assets.lochinvar.com/damroot/Original/10014/100305786_2000558371_Rev%20C_AWH%20Modbus%20Bacnet%20Manual%20(52880).pdf",
  "pages": "pp. 3-6 (Modbus configuration, exception codes), 7-8 (memory map, configuration bits), 18-21 (unit operation, conversions), 22-23 (codes)"
 },
 "notes": [
  "Temperatures: the conversion section says the Armor passes temperatures in degrees C and the value must be divided by 10. Scale 0.1 is applied to the temperature registers with 0.1 resolution in the map.",
  "Left out: System/Cascade Setpoint (30004) and Tank Setpoint (40004). The map gives them a 0.5 C resolution while the conversion text says temperatures are C x 10, so their scaling is not settled.",
  "Signed types: inlet, flue and tank temperatures have negative minimums in the map and are listed as INT16; the manual itself only says 16-bit word.",
  "Input registers 30001-30003 and 30026 are packed copies of the discrete inputs; the bit order is not stated, so they are UINT16. Use the discrete inputs instead.",
  "The smaller Armor 151-1000 uses a different manual; see the Knight/Armor map."
 ],
 "registers": [
  {
   "table": "coil",
   "address": 0,
   "documented": "00001",
   "name": "Enable",
   "description": "Enable command from the BAS.",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "RW",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "coil",
   "address": 4,
   "documented": "00005",
   "name": "Tank Thermostat",
   "description": "DHW tank thermostat demand from the BAS.",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "RW",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 0,
   "documented": "10001",
   "name": "Manual Reset High Limit",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 1,
   "documented": "10002",
   "name": "Flow Switch",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 2,
   "documented": "10003",
   "name": "Gas Pressure Switch",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 3,
   "documented": "10004",
   "name": "Louver Proving Switch",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 5,
   "documented": "10006",
   "name": "Blocked Drain Switch",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 6,
   "documented": "10007",
   "name": "Auto Reset High Limit",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 7,
   "documented": "10008",
   "name": "Flame",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 8,
   "documented": "10009",
   "name": "Enable",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 9,
   "documented": "10010",
   "name": "Tank Thermostat",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 32,
   "documented": "10033",
   "name": "Run-time Contacts",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 33,
   "documented": "10034",
   "name": "Alarm Contacts",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 35,
   "documented": "10036",
   "name": "DHW Pump",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 37,
   "documented": "10038",
   "name": "Gas Valve",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 38,
   "documented": "10039",
   "name": "Recirculation Pump",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "discrete_input",
   "address": 48,
   "documented": "10049",
   "name": "Blower Power",
   "description": "",
   "data_type": "BIT",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "Off",
    "1": "On"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 0,
   "documented": "30001",
   "name": "Discrete Inputs 1-16",
   "description": "Packed copy of discrete inputs 1-16.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 1,
   "documented": "30002",
   "name": "Discrete Inputs 17-32",
   "description": "Packed copy of discrete inputs 17-32.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 2,
   "documented": "30003",
   "name": "Discrete Inputs 33-48",
   "description": "Packed copy of discrete inputs 33-48.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 5,
   "documented": "30006",
   "name": "Cascade Total Power",
   "description": "Total cascade capacity (100-800 %).",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "%",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 6,
   "documented": "30007",
   "name": "Cascade Current Power",
   "description": "Current cascade output (0-800 %).",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "%",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 8,
   "documented": "30009",
   "name": "Outlet Temperature",
   "description": "Raw is degrees C x 10.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 0.1,
   "units": "°C",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 9,
   "documented": "30010",
   "name": "Inlet Temperature",
   "description": "",
   "data_type": "INT16",
   "length": 1,
   "word_order": null,
   "scale": 0.1,
   "units": "°C",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 10,
   "documented": "30011",
   "name": "Flue Temperature",
   "description": "",
   "data_type": "INT16",
   "length": 1,
   "word_order": null,
   "scale": 0.1,
   "units": "°C",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 11,
   "documented": "30012",
   "name": "Firing Rate",
   "description": "0-100 %.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "%",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 13,
   "documented": "30014",
   "name": "Status Code",
   "description": "What the unit is doing; 40 = lockout.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "2": "Heat demand blocked: high outlet temperature",
    "3": "Heat demand blocked: high flue temperature",
    "4": "Heat demand blocked: high delta T",
    "7": "Heat demand blocked: different personality plug code",
    "8": "Heat demand blocked: low 24 VAC",
    "10": "Blocked: switched off at the display",
    "16": "Service mode active",
    "18": "Water heater DHW demand active",
    "23": "Heat demand from cascade",
    "30": "Freeze protection heat demand",
    "32": "DHW pump delay",
    "34": "Standby",
    "40": "Lockout"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 14,
   "documented": "30015",
   "name": "Blocking Code",
   "description": "Why heat demand is blocked.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "0": "No blocking",
    "1": "Flow switch open",
    "5": "Low 24 VAC supply",
    "6": "Manual reset high limit",
    "8": "Appliance turned off",
    "10": "High delta T",
    "11": "High outlet temperature",
    "12": "Anti-cycling",
    "13": "Different personality plug setting",
    "15": "High flue temperature"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 15,
   "documented": "30016",
   "name": "Lockout Code",
   "description": "Only valid while the status code is 40.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": {
    "240": "Manual reset high limit",
    "237": "Flame out of sequence",
    "233": "No flame at ignition",
    "232": "No flame while running",
    "231": "High fan speed",
    "230": "Low fan speed",
    "229": "Watchdog",
    "207": "EEPROM error",
    "206": "EEPROM programming error",
    "205": "EEPROM programmed",
    "204": "EEPROM CRC fault",
    "193": "Outlet sensor open",
    "192": "Outlet sensor shorted",
    "180": "Inlet sensor open",
    "179": "Inlet sensor shorted",
    "178": "Flue sensor open",
    "170": "Flow switch open",
    "169": "Gas pressure switch open",
    "168": "Louver proving switch open",
    "167": "Blocked drain switch open",
    "166": "Auto reset high limit",
    "164": "Flame current circuit test failed",
    "163": "Different personality plug"
   },
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 25,
   "documented": "30026",
   "name": "Discrete Inputs 49-64",
   "description": "Packed copy of discrete inputs 49-64.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 26,
   "documented": "30027",
   "name": "Lockout Code Leader",
   "description": "Lockout code of the cascade leader.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 27,
   "documented": "30028",
   "name": "Lockout Code Member 1",
   "description": "Lockout code of cascade member 1.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 28,
   "documented": "30029",
   "name": "Lockout Code Member 2",
   "description": "Lockout code of cascade member 2.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 29,
   "documented": "30030",
   "name": "Lockout Code Member 3",
   "description": "Lockout code of cascade member 3.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 30,
   "documented": "30031",
   "name": "Lockout Code Member 4",
   "description": "Lockout code of cascade member 4.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 31,
   "documented": "30032",
   "name": "Lockout Code Member 5",
   "description": "Lockout code of cascade member 5.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 32,
   "documented": "30033",
   "name": "Lockout Code Member 6",
   "description": "Lockout code of cascade member 6.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "input_register",
   "address": 33,
   "documented": "30034",
   "name": "Lockout Code Member 7",
   "description": "Lockout code of cascade member 7.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "R",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "holding_register",
   "address": 0,
   "documented": "40001",
   "name": "Configuration",
   "description": "Selects which values the BAS supplies instead of the unit's own inputs.",
   "data_type": "BITMAP16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "RW",
   "values": null,
   "bits": {
    "0": "Enable from BAS",
    "1": "Tank Thermostat from BAS",
    "2": "Rate Command / 0-10V Input / Setpoint Command from BAS",
    "3": "Tank Setpoint from BAS",
    "6": "Tank Temperature from BAS"
   },
   "offset": 0
  },
  {
   "table": "holding_register",
   "address": 1,
   "documented": "40002",
   "name": "Coils",
   "description": "Command word; the manual writes 0x0001 to enable and 0x0000 to disable.",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "",
   "access": "RW",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "holding_register",
   "address": 2,
   "documented": "40003",
   "name": "0-10 Volt Input / Rate Command / Setpoint Command",
   "description": "Modulation % or setpoint, per the BMS type setting (0-100).",
   "data_type": "UINT16",
   "length": 1,
   "word_order": null,
   "scale": 1,
   "units": "%",
   "access": "RW",
   "values": null,
   "bits": null,
   "offset": 0
  },
  {
   "table": "holding_register",
   "address": 4,
   "documented": "40005",
   "name": "Tank Temperature",
   "description": "Tank temperature supplied by the BAS.",
   "data_type": "INT16",
   "length": 1,
   "word_order": null,
   "scale": 0.1,
   "units": "°C",
   "access": "RW",
   "values": null,
   "bits": null,
   "offset": 0
  }
 ],
 "integration": {
  "summary": "Set address, baud and parity on the board DIP switches, set parameter H5 ModBus to Active, then write 40001 and the commands: enable only = 40001 0x0001 + 40002 0x0001; enable + BMS = 40001 0x0005 + 40002 0x0001 + 40003 rate; BMS only = 40001 0x0004 + 40003. Monitor 30009-30016.",
  "minimum_registers": [
   {
    "table": "holding_register",
    "address": 0,
    "why": "Configuration bits"
   },
   {
    "table": "holding_register",
    "address": 1,
    "why": "Enable command"
   },
   {
    "table": "holding_register",
    "address": 2,
    "why": "Rate (%) or setpoint command"
   },
   {
    "table": "input_register",
    "address": 8,
    "why": "Outlet temperature"
   },
   {
    "table": "input_register",
    "address": 11,
    "why": "Firing rate"
   },
   {
    "table": "input_register",
    "address": 13,
    "why": "Status code"
   },
   {
    "table": "input_register",
    "address": 14,
    "why": "Blocking code"
   },
   {
    "table": "input_register",
    "address": 15,
    "why": "Lockout code"
   }
  ],
  "enable": "Monitoring works with the default control setup. To send commands set parameter H5 ModBus to Active (see the Armor service manual), choose the enable/BMS demand configuration, and re-send 40001 before each command.",
  "watchdog": "Two timers: a BAS-supplied tank temperature must be refreshed within parameter H6 ModBus Time (the operation section gives 1-255 s; the configuration section says 5-120 s, default 10 s); all other commands time out after a fixed 4 minutes, after which the control reverts to its local inputs.",
  "quirks": [
   "Modicon addressing: 30009 is input register 8 on the wire.",
   "Temperatures are degrees C x 10.",
   "A setpoint sent through 40003 is the 0-10 V equivalent percentage interpolated from the BMS low/high setpoint parameters, not degrees.",
   "Read the lockout code only when the status code is 40."
  ],
  "setup": [
   "DIP switches 1-8: Modbus address (binary sum, 1-247).",
   "DIP switch 9: 0 = 9600 baud, 1 = 19200 baud.",
   "DIP switch 10: 0 = no parity with 2 stop bits, 1 = even parity with 1 stop bit.",
   "RTU only; check 120 ohm termination."
  ],
  "gotchas": [
   "Board LED D7: 1 s bright / 1 s dim = normal; 1.5 s on / 0.5 s off = no Modbus traffic; 0.5 s on / 1.5 s off = no burner-control communication."
  ]
 },
 "page": "https://easymodbus.com/modbus-register-maps/lochinvar/armor-1250-4000-modbus",
 "address_note": "address = 0-based Modbus wire (PDU) address; documented = as printed in the source.",
 "note": "Re-typed from the manufacturer's public documentation (see source) and verified against it. Registers vary by firmware and options; verify against the live device before writing."
}
