Register map¶

This page is generated from fujilib.registry (design §5.1). To change it, change the registry and run python scripts/gen_register_docs.py.

Conventions¶

• Address is the 0-based relative address, exactly as on the wire. Register is the register number: 40001 + address for holding registers, 30001 + address for input registers.
• FC lists the function codes fujilib may use: 03 read holding, 04 read input, 06 write single, 10 write multiple. FC06 reaches only 0000h-009Dh.
• Tier is the safety tier of a write. Every read is READ_ONLY, and so is every register fujilib never writes.
• What is writable. Only the reviewed subset of design §5.4: the calibration gases and calibration scope, the response times, output hold and the hold settings, and each channel's range and range method. They are documented, the bench unit does not contradict them, they are not options, and the bench analyzer can test them all. Every other register is read-only, including the documented alarm, schedule, key-lock, averaging, O2-correction, peak-alarm, blowback, measurement-point and reference-gas settings.
• Limits are raw, before scaling. For a writable register they are the limits of a write: the narrower of the two manuals' where they disagree, since the MODBUS manual defers setting ranges to the instruction manual (TN5A1190a p.28). write lists the only values a write may use, or its limits in percent of the range's full scale. Scaling says where the decimal point comes from: inline (the two registers after a concentration), by_range (the channel and range's decimal-point register), by_alarm_target (the range of the alarm's target channel), or fixed(n). A scaled concentration takes its unit from the same place.
• Evidence: documented by the manuals; observed on the bench unit (firmware 1.02) but undocumented; inferred, an interpretation; contested, documented but contradicted by the bench unit. Only documented registers are ever writable.
• Ref gives the PDF page of the manual, which matches the page markers of the text extracts. The printed page number is 3 lower in TN5A1190a, 13 lower in TN2ZPAb and 8 lower in TN5A1191b.

Summary¶

Holding registers¶

Calibration gas¶

• calibration_gas.ch1.range1.zero, calibration_gas.ch1.range1.span, calibration_gas.ch1.range2.zero, calibration_gas.ch1.range2.span, calibration_gas.ch2.range1.zero, calibration_gas.ch2.range1.span, calibration_gas.ch2.range2.zero, calibration_gas.ch2.range2.span, calibration_gas.ch3.range1.zero, calibration_gas.ch3.range1.span, calibration_gas.ch3.range2.zero, calibration_gas.ch3.range2.span, calibration_gas.ch4.range1.zero, calibration_gas.ch4.range1.span, calibration_gas.ch4.range2.zero, calibration_gas.ch4.range2.span, calibration_gas.ch5.range1.zero, calibration_gas.ch5.range1.span, calibration_gas.ch5.range2.zero, calibration_gas.ch5.range2.span: Takes effect at the next calibration, manual or automatic (ZPA p.42). Writes are limited to 0-100 %FS for zero gas and 1-105 %FS for span gas: the ZPA manual gives 1-105 %FS for span gas and no zero-gas limit for NDIR or built-in O2 (ZPA p.42). Its separate limits for external zirconia and reverse-range O2 are not modelled, so some legal values there are refused.

Auto calibration¶

• auto_calibration.ch1.included, auto_calibration.ch2.included, auto_calibration.ch3.included, auto_calibration.ch4.included, auto_calibration.ch5.included: The same list chooses the channels of auto zero calibration (ZPA p.59). Their zero is done together, their span one after another from Ch1 (ZPA p.47).
• auto_calibration.start_hour, auto_calibration.start_minute: The manual says BCD (00h-23h / 00h-59h). The bench unit reads 0x000C, which is not BCD, in all three schedules, so the encoding is unconfirmed and the value is kept raw (design §2.6).
• auto_calibration.cycle: No limits in the MODBUS manual; the ZPA manual gives 1-99 h or 1-40 days (ZPA p.55, p.93).
• auto_calibration.enabled: Switch it off before changing the schedule (ZPA p.53). A schedule resumes after a power failure at its next start time (ZPA p.55).
• auto_calibration.ch1.range, auto_calibration.ch2.range, auto_calibration.ch3.range, auto_calibration.ch4.range, auto_calibration.ch5.range: The channel switches to this range for the calibration and back afterwards, so the current range can change during one (ZPA p.46).
• auto_calibration.flow_time1, auto_calibration.flow_time2, auto_calibration.flow_time3, auto_calibration.flow_time4, auto_calibration.flow_time5, auto_calibration.flow_time6, auto_calibration.flow_time7: Which gas each time belongs to is not stated. The ZPA flow-time screen suggests 1 zero, 2-6 Ch1-Ch5 span, 7 the hold extension after calibration (inferred, ZPA p.31, p.54-55). Each should be at least five times the channel's response time (ZPA p.54).

Calibration scope¶

• calibration.ch1.zero_mode, calibration.ch2.zero_mode, calibration.ch3.zero_mode, calibration.ch4.zero_mode, calibration.ch5.zero_mode: Affects only a manual zero started at the panel. Auto calibration and auto zero calibration zero every enabled channel together whatever it says (ZPA p.47).
• calibration.ch1.range_mode, calibration.ch2.range_mode, calibration.ch3.range_mode, calibration.ch4.range_mode, calibration.ch5.range_mode: 'Both' calibrates range 1 and range 2 together (ZPA p.45).

Alarms¶

• alarm1.range1.high, alarm1.range1.low, alarm1.range2.high, alarm1.range2.low, alarm2.range1.high, alarm2.range1.low, alarm2.range2.high, alarm2.range2.low, alarm3.range1.high, alarm3.range1.low, alarm3.range2.high, alarm3.range2.low, alarm4.range1.high, alarm4.range1.low, alarm4.range2.high, alarm4.range2.low, alarm5.range1.high, alarm5.range1.low, alarm5.range2.high, alarm5.range2.low: Scaled by the range of the alarm's target channel; the target encoding is contested. The manual labels these 'Ch1-Ch5'; they are per alarm (design §2.6). The ZPA manual limits them to 0-100 %FS, with the high limit above the low one by more than the hysteresis, and 0 meaning no alarm (ZPA p.48).
• alarm1.enabled, alarm2.enabled, alarm3.enabled, alarm4.enabled, alarm5.enabled: Switch the alarm off before changing its settings (ZPA p.48).
• alarm1.target_channel, alarm2.target_channel, alarm3.target_channel, alarm4.target_channel, alarm5.target_channel, alarm6.target_channel: The manual gives 0-6 without saying what the values mean. The bench unit reads 0-4 for alarms 1-5 (channel - 1?) and 12 for alarm 6.
• alarm6.range1.high, alarm6.range1.low, alarm6.range2.high, alarm6.range2.low: Scaled by the range of the alarm's target channel; the target encoding is contested. The ZPA manual limits them to 0-100 %FS, with the high limit above the low one by more than the hysteresis, and 0 meaning no alarm (ZPA p.48).
• alarm6.enabled: Alarm 6 is an option the ZPA manual never mentions (TN5A1190a p.31).

Key lock¶

• key_lock: Locks every panel key but the key lock itself, including the forced stop of a running auto calibration (ZPA p.55, p.64). It does not block Modbus writes: the bench unit applied a setting written while it was on (protocol findings §13.3).

Response time¶

• response_time.ndir1, response_time.ndir2, response_time.ndir3, response_time.ndir4: The manual's 'Ch1-Ch4' slots are NDIR components; O2 has its own slot (40084) whatever its channel. The MODBUS manual gives 0-60 s, the ZPA manual 1-60 s (ZPA p.65). On the bench unit the filter is a moving average as long as the setting, and 0 switches it off: the A/D value then equals the unsmoothed detector count (protocol findings §20).
• response_time.o2: The MODBUS manual gives 0-60 s, the ZPA manual 1-60 s (ZPA p.65). On the bench unit the filter is a moving average as long as the setting, and 0 switches it off: the O2 reading then follows every count of the detector (protocol findings §20).

Moving average¶

• moving_average1.period, moving_average2.period, moving_average3.period, moving_average4.period: Which output each of the four 'orders' averages is not stated. The ZPA manual gives 1-59 min or 1-4 h (ZPA p.65, p.68). Changing a period restarts that average (ZPA p.68).

Output hold¶

• output_hold.enabled: Holds the analog outputs and the Modbus concentration registers during a manual or automatic calibration and its gas-replacement time; the display is never held (ZPA p.65, p.67).

O2 correction¶

• o2_correction.reference: The ZPA manual gives 0-19 %, set in the password-protected maintenance mode (ZPA p.73).
• o2_correction.limit: Set in the password-protected maintenance mode (ZPA p.73).

Peak alarm¶

• peak_alarm.enabled: The CO peak alarm is an option (ZPA p.51). Switching it on restarts the count from 0 (ZPA p.52).
• peak_alarm.concentration: The CO peak alarm is an option (ZPA p.51). The ZPA manual gives 10-1000 ppm in 5 ppm steps (ZPA p.52).
• peak_alarm.count, peak_alarm.hysteresis: The CO peak alarm is an option (ZPA p.51).

Auto zero calibration¶

• auto_zero.start_hour, auto_zero.start_minute: The manual says BCD (00h-23h / 00h-59h). The bench unit reads 0x000C, which is not BCD, in all three schedules, so the encoding is unconfirmed and the value is kept raw (design §2.6).
• auto_zero.cycle: No limits in the MODBUS manual; the ZPA manual gives 1-99 h or 1-40 days (ZPA p.60, p.93).
• auto_zero.enabled: Switch it off before changing the schedule (ZPA p.59). Where it falls due with an auto calibration, the auto calibration runs instead (ZPA p.60).
• auto_zero.flow_time: The gas replacement time after the calibration is the same (ZPA p.60).

Ranges¶

• range.ch1.selected, range.ch2.selected, range.ch3.selected, range.ch4.selected, range.ch5.selected: The MODBUS manual says it is ignored while remote range is on; the ZPA manual, while the method is remote or auto (ZPA p.40). A write needs the method to be manual. The current range follows some tens of milliseconds after the write reads back (protocol findings §13.2); fujilib waits for it.
• range.ch1.method, range.ch2.method, range.ch3.method, range.ch4.method, range.ch5.method: Remote range follows an input contact of the DIO option (ZPA p.29), so it is not written.

Hold¶

• hold.mode: On the panel it can be chosen only while output hold is on (ZPA p.66).
• hold.ch1.value, hold.ch2.value, hold.ch3.value, hold.ch4.value, hold.ch5.value: In percent of the full scale of whichever range is in use (ZPA p.67).

Blowback¶

• blowback.start_hour, blowback.start_minute: The manual says BCD (00h-23h / 00h-59h). The bench unit reads 0x000C, which is not BCD, in all three schedules, so the encoding is unconfirmed and the value is kept raw (design §2.6).
• blowback.cycle: 1-99 in hours, 1-7 in days.
• blowback.enabled: Blowback appears in neither the ZPA manual nor its code table, nor in the service manual's ZPA parts list (TN5A1191b p.10).

Measurement point¶

• measurement_point.cycle: 1-60 in minutes, 1-99 in hours. Not in the ZPA manual.

Reference gas (ZPB/ZPG)¶

Interference compensation¶

• interference.coefficient1, interference.coefficient2, interference.coefficient3, interference.coefficient4: The manual lists 00A4h and 00A5h as two words with no limits and does not list 00A6h-00ABh. The bench unit reads four long words of 1,000,000.

Input registers¶

Readings¶

• reading.ch1.value, reading.ch2.value, reading.ch3.value, reading.ch4.value, reading.ch5.value, reading.ch6.value, reading.ch7.value, reading.ch8.value, reading.ch9.value, reading.ch10.value, reading.ch11.value, reading.ch12.value: Over-range is not flagged: the computed value is still sent.

Status¶

• alarm1.state, alarm2.state, alarm3.state, alarm4.state, alarm5.state: The manual labels these 'Ch1-Ch5'; they are per alarm (design §2.6).
• alarm6.state: The manual gives no domain; taken to be that of alarms 1-5.

Errors¶

Display¶

• display.calibration_step: A step only while the screen (30181) shows measurement, as the manual defines it. On the bench unit's other screens it numbered the pages: 1, 2, 22 and 23 for the maintenance menu's sensor input, error log and calibration log, 5 for the factory password, and values up to 78 in factory mode, 4, 8 and 11-13 among them.
• display.calibration_result: Marked 'do not use' by the manual (30186). On the bench unit it went to 0 when ENT selected the channel, 4 when the calibration started and 6 when it finished, and kept 6 until the next selection; a cancel left 0. Its value after a calibration error is not known.
• display.key: Not in the manual's map (30190). On the bench unit it showed ZERO 64, DOWN 8, ENT 32, SPAN 128 and ESC 16 for about one 0.5 s read each, then 0.

Clock¶

A/D values¶

• adc.input1, adc.input2, adc.input3, adc.input4, adc.input5, adc.temperature1, adc.temperature2, adc.temperature3, adc.temperature4, adc.temperature5, adc.resistance1_1, adc.resistance2_1, adc.resistance3_1, adc.resistance4_1, adc.pressure, adc.reference_voltage, adc.ground, adc.resistance1_2, adc.resistance2_2, adc.resistance3_2, adc.resistance4_2: Names follow the service manual's table order; the block is undocumented.

Ranges¶

• range.ch1.range1.unit, range.ch1.range2.unit, range.ch2.range1.unit, range.ch2.range2.unit, range.ch3.range1.unit, range.ch3.range2.unit, range.ch4.range1.unit, range.ch4.range2.unit, range.ch5.range1.unit, range.ch5.range2.unit: The manual's list omits '1: ppm'; the other unit tables have it.

Identity¶

• identity.serial_number: On the bench unit it is the serial number (protocol findings §2).

Logs¶

Error log¶

The 14 newest errors, newest first. No year and no month.

error_log: FC04, 1 region(s) of 14 records x 5 words from 003Dh to 0082h. Requires: -. Evidence: documented. Ref: TN5A1190a p.35-36, p.46.

Calibration log¶

Per channel, the 40 newest calibrations, newest first. No year.

calibration_log: FC04, 5 region(s) of 40 records x 9 words from 1000h to 1707h; channel c starts at 1000h + 360(c - 1). Requires: CALIBRATION_LOG. Evidence: documented. Ref: TN5A1190a p.40-45.

Firmware 2.24 or later, so never seen on the bench unit. The deviation's x10 scaling is implied by its one decimal, not stated. The panel's own log keeps 10 records per component (ZPA p.71).

Write envelope¶

Everything fujilib may ever write. The envelope is frozen and independent of the registry; the Modbus client re-checks every write against it, its value too where the envelope limits it (design §5.4). 00A4h-00ABh are outside it.

Front-panel keys¶

Written with FC06 to 07D0h (42001), one key at a time, only by the front-panel driver of a manual zero or span (design §6.5): each is sent only on the steps where it belongs, and confirmed by the panel's reads. MODE and SIDE, which open the menus and enter their passwords, are outside the envelope.

Operation commands¶

Written with FC06, one value each; not reachable by writing a parameter.

Enumerations¶

• AlarmMode: 0 HIGH, 1 LOW, 2 HIGH_OR_LOW, 3 HIGH_HIGH, 4 LOW_LOW
• AlarmState: 0 NONE, 1 HIGH, 2 LOW, 3 HIGH_HIGH, 4 LOW_LOW
• CalibrationKind: 0 ZERO_RANGE1, 1 SPAN_RANGE1, 2 ZERO_RANGE2, 3 SPAN_RANGE2
• CalibrationRangeMode: 0 CURRENT, 1 BOTH
• DayOfWeek: 0 SUNDAY, 1 MONDAY, 2 TUESDAY, 3 WEDNESDAY, 4 THURSDAY, 5 FRIDAY, 6 SATURDAY
• DisplayScreen: 0 MEASUREMENT, 1 MENU, 2 RANGE_CHANGE, 3 CALIBRATION_SETTING, 4 ALARM_SETTING, 5 AUTO_CALIBRATION_SETTING, 6 PEAK_ALARM_SETTING, 7 PARAMETER_SETTING, 8 MAINTENANCE, 9 FACTORY, 10 AUTO_ZERO_SETTING
• HoldMode: 0 LAST_VALUE, 1 SETTING
• ManualCalibrationResult: 0 NONE, 4 RUNNING, 6 COMPLETED
• ManualCalibrationStep: 0 NONE, 4 ZERO_CHANNEL_SELECT, 5 ZERO_WAIT, 6 ZERO_RUNNING, 7 SPAN_CHANNEL_SELECT, 8 SPAN_WAIT, 9 SPAN_RUNNING, 10 ERROR_DISPLAY
• MeasurementPoint: 0 LINE_1, 1 LINE_2, 2 SWITCHING
• PeriodUnit: 0 HOURS, 1 MINUTES
• RangeIndex: 0 RANGE_1, 1 RANGE_2
• RangeMethod: 0 MANUAL, 1 REMOTE, 2 AUTO
• ScheduleCycleUnit: 0 HOURS, 1 DAYS
• ZeroCalibrationMode: 0 EACH, 1 AT_ONCE