Configure a digital input pin on a Z45 Controller

You can configure an input pin for digital data.

  1. Log into the Z45 Controller's web UI.

    1. From the Options section, click Applications. The Available Applications page displays.

    2. Click Automation Control. The Management & Administration page displays.

    3. Click Inputs. The Input Configuration page displays.

  3. In the Input Type column, click on a Disabled button.

    Note An input pin with an input type other than Disabled has already been configured and can be updated.

  4. At the top of the page, click Digital.

  5. Configure the settings as described in the tables below.

    Digital Input Source

    Item Description

    Primary Source

    Select an input source option.

    • Configured Inputs: Select an input pin.

    • Configured Outputs: Select an output pin.

    • System Variables: Select a standard data option.

    • Onboard I/O

    Additional Modifiers

    Use the Additional Modifiers to take the value you have coming in from the pin and combine it with multiple digital inputs or outputs, outside of a formula.

    • Operation: Select AND or OR.

    • Source: Select an input source.

    General Pin Options

    Item Description

    Initial Value

    Enter an initial value for the input pin. This value is used in formulas after you change the input pin configuration but before the Z45 Controller does a reading.

    Polarity

    Select the polarity for the input pin to specify which status option signifies "off".

    • 0: 0 is off.

    • 1: 1 is off.

    Formula

    (Optional) Select an existing formula from the Formula list box.

    When data is received from the input source, the formula is run, and the result is the output value for this source.

    Logging Options

    Note Configuring application logging is one step in a larger event logging process. For information about the complete process, see Application logging overview.

    Item Description

    Log Rate (sec)

    Specify how often the Z45 Controller should log a change to the value of the calculated formula. The log rate is measure in seconds.

    • 0: Do not log any changes.

    • 1: Signifies that every change is logged when it occurs, and is not dependent on a time interval.

    • 2, 3, ...: The time interval at which the value is logged.

    This data is displayed in either the Events tab or the Details tab in the Automation Control Log. The type of data logged is determined by the option selected for the System Log Trigger field.

    System Log Trigger

    Determine whether you want gather event data or system data.

    • Disable: The data is saved to an event log, which is local to the device. The data is displayed in the Events tab in the Automation Control Log. This is the default.

    • Enable: The data is saved to a systems log, which is sent to Digi Axess. The data is displayed in both the Events tab and the Details tab in the Automation Control Log.

    MQTT Publish

    Determine whether you want to publish the messages when the device connects to the broker.

    • Off: The current input does not publish an MQTT message.

    • Auto: The MQTT message is delivered using the topic structure defined by the device. For example, the device may use the MAC address to define the device:

      <MAC Address>/input/1

    where <MAC Address> is the MAC address for the device

    • Defined Topic: The MQTT message is delivered with a user-defined topic. When you choose this option, the Topic field displays, in which you can enter a topic name. The topic Off is entered by default.

    MQTT Subscribe

    Determine whether you want to subscribe to MQTT messages.

    • Off: The current input does not subscribe to an MQTT message.

    • Auto: The MQTT message is delivered using the topic structure defined by the device. This uses MAC address to define the device. For example, the device may use the MAC address to define the device:

      <MAC Address>/input/1

    where <MAC Address> is the MAC address for the device

    • Defined Topic: The MQTT message is delivered with a user-defined topic. When you choose this option, the Topic field displays, in which you can enter a topic name. The topic Off is entered by default.

    Display Options

    Item Description

    Input Name

    Enter a descriptive name for in the input source. The name should be unique.

    [ON Label]

    Enter a label that describes the "on" state of the input pin and displays instead of the "on" Polarity option (1 or 0). This label displays on the Digi Axess pages and graphs. This label works with the [OFF] Label.

    For example, the [ON] and [OFF] labels could say HIGH and LOW, or ON and OFF.

    [OFF Label]

    Enter a label that describes the "off" state of the input pin and displays instead of the "off" Polarity option (1 or 0). This label displays on the Digi Axess pages and graphs. This label works with the [ON] Label.

    For example, the [ON] and [OFF] labels could say HIGH and LOW, or ON and OFF.

    Display Value

    Select the label(s) for this input source that should display within Digi Axess.

    • Input Source: Display only the Input Name label entered in the Display Options section.

    • Threshold Alert: Display only the Threshold Alert label entered in the Thresholds section. The Threshold Alert label is available only if a threshold has been configured and then applied to this device.

    • Both: Display both the Input Name label and the Threshold Alert label.

    Indicator Type

    Specify whether the status of an alarm should display as a colored dot on the Device Summary page and the Automation Dashboard.

    • None: The colored dot displays in gray.

    • LED: The colored dot displays the color configured in the Alarm State list box.

    Local Display Group

    From the Local Display Group list box, select a local display group in which the data from this output pin should be included. The group displays on the Automation Dashboard. The group displays locally and is in addition to what displays from the web UI.

    Options:

    • 00 - Off: No local display group is selected to display.

    • 01 - {name} to 24 - {name}: Select a local display group in which the data from this pin should be displayed. See Configure the local and remote dashboard groups for information about naming and displaying the local display groups.

    Remote Access Options

    Item Description

    Remote Display Group

    Select the name of the group that displays the result of a calculated formula on the Automation Dashboard.

    • 00 - Disabled: A remote display group does not display.

    • 01 - {name} through 24 - {name}: Select a remote display group in which the data from this pin should be displayed. See Configure the local and remote dashboard groups for information about naming and displaying the remote display groups.

    Remote Display Sources

    Specify the platform(s) on which the user can view the group on the Automation Dashboard.

    • Cloud Only: The Z45 Controller web UI or Digi Axess. This is the default.

    • Phone Only: The Digi Axess Mobile app.

    • Cloud/Phone: The Z45 Controller web UI, Digi Axess, or the Digi Mobile application.

    Remote Control

    Specify whether users can change the value of an output from Digi Axess or the Digi Mobile app.

    • Disabled: Do not allow changes. This is the default.

    • Enabled: Changes are allowed.

  6. You can configure a threshold for the on and off states of the input pin, if needed. When a threshold is enabled and the threshold value is met, an LED button that displays next to the [ON] Label or [OFF] Label changes to the color selected from the Alarm State list box.

    Alarms/Programs: OFF State Alarms

    Item Description

    Alarm

    You can enable a threshold alarm for when the input pin changes to the [OFF] State by selecting a notification group from the Off State Alarm list box.

    When a threshold is enabled and the Off State Threshold Alert value is met, an LED button that displays next to the [OFF] Label changes to the color selected from the Off State Alarm State list box.

    Repeat

    The number of times the alarm should be sent after the initial alarm is sent.

    Interval (sec)

    The time interval between the repeated alarms. The time is measured in seconds.

    Threshold Alert

    Enter an Off State Threshold Value that is compared to the input source value. If the value of the input pin matches the threshold value, a colored alarm dot displays within Digi Axess.

    The color is determined by the Off State Alarm State option.

    Alarm State

    Select a color for the colored dot that displays next to the [OFF] Label in Digi Axess pages when the Off State Threshold Alert value is met.

    • None: The dot is gray.

    • Green

    • Yellow

    • Red: The red dot blinks.

    • Blue

    Program

    Select a program to run when the alarm threshold is met and an alarm is sent.

    • 00-Off: No program is run. This is the default.

    • Program list: The program selected from the list of options runs when the alarm is sent.

    Repeat

    The number of times the alarm should be sent after the initial alarm is sent.

    Interval (sec)

    The time interval between the repeated alarms. The time is measured in seconds.

     

    Alarms/Programs: ON State Alarms

    Item Description

    Alarm

    You can enable a threshold alarm for when the input pin changes to the [ON] State by selecting a notification group from the On State Alarm list box.

    When a threshold is enabled and the On State Threshold Alert value is met, an LED button that displays next to the [ON] Label changes to the color selected from the On State Alarm State list box.

    Repeat

    The number of times the alarm should be sent after the initial alarm is sent.

    Interval (sec)

    The time interval between the repeated alarms. The time is measured in seconds.

    Threshold Alert

    Enter a Threshold Value that is compared to the input source value. If the value of the input pin matches the threshold value, a colored alarm dot displays within Digi Axess.

    The color is determined by the On State Alarm State option.

    Alarm State

    Select a color for the dot button that displays next to the [ON] Label in Digi Axess pages when the On State Threshold Alert value is met.

    • None: The dot is gray.

    • Green

    • Yellow

    • Red: The red dot blinks.

    • Blue

    Program

    Select a program to run when the alarm threshold is met and an alarm is sent.

    • 00-Off: No program is run. This is the default.

    • Program list: The program selected from the list of options runs when the alarm is sent.

    Repeat

    The number of times the alarm should be sent after the initial alarm is sent.

    Interval (sec)

    The time interval between the repeated alarms. The time is measured in seconds.

  7. Click Enable. A confirmation dialog displays.

  8. Click OK. Click Back to return to the Input Configuration page.