bacnet-device/dist/objects/analoginput.d.ts

A TypeScript library for implementing BACnet IP devices in Node.js.

import { BDSingletProperty } from '../properties/index.js';
import { BDObject } from '../object.js';
import { ApplicationTag, EventState, EngineeringUnits, Reliability } from '@innovation-system/node-bacnet';
export interface BDAnalogInputOpts {
    name: string;
    unit: EngineeringUnits;
    description?: string;
    minPresentValue?: number;
    maxPresentValue?: number;
    presentValue?: number;
    covIncrement?: number;
}
/**
 * Implements a BACnet Analog Input object
 *
 * The Analog Input object represents a physical or virtual analog input source such as a
 * temperature sensor, pressure sensor, or other analog measurement device. This object
 * type provides a standard way to represent analog inputs in BACnet systems.
 *
 * Required properties according to the BACnet specification:
 * - Object_Identifier (automatically added by BACnetObject)
 * - Object_Name (automatically added by BACnetObject)
 * - Object_Type (automatically added by BACnetObject)
 * - Present_Value (read-only unless Out_Of_Service is true)
 * - Status_Flags
 * - Event_State
 * - Out_Of_Service
 * - Units
 * - Reliability (optional but commonly included)
 *
 * @extends BDObject
 */
export declare class BDAnalogInput extends BDObject {
    /**
     * The current value of the analog input
     *
     * This property represents the current value of the analog input in the
     * units specified by the engineeringUnit property. It's read-only unless
     * outOfService is set to true.
     */
    readonly presentValue: BDSingletProperty<ApplicationTag.REAL>;
    readonly maxPresentValue: BDSingletProperty<ApplicationTag.REAL>;
    readonly minPresentValue: BDSingletProperty<ApplicationTag.REAL>;
    /**
     * The current status flags for this object
     *
     * This property contains four flags: IN_ALARM, FAULT, OVERRIDDEN, and OUT_OF_SERVICE.
     * These flags provide a summary of the object's current status.
     */
    readonly statusFlags: BDSingletProperty<ApplicationTag.BIT_STRING>;
    /**
     * The current event state of this object
     *
     * This property indicates whether the object is in an alarm condition.
     * For objects that do not support event reporting, this is typically NORMAL.
     */
    readonly eventState: BDSingletProperty<ApplicationTag.ENUMERATED, EventState>;
    /**
     * The engineering units for the present value
     *
     * This property specifies the units of measurement for the present value,
     * such as degrees Celsius, Pascal, etc.
     */
    readonly engineeringUnit: BDSingletProperty<ApplicationTag.ENUMERATED, EngineeringUnits>;
    /**
     * Indicates whether this object is out of service
     *
     * When true, the Present_Value property is decoupled from the physical input
     * and can be modified directly for testing or other purposes.
     */
    readonly outOfService: BDSingletProperty<ApplicationTag.BOOLEAN>;
    /**
     * The reliability of the present value
     *
     * This property indicates whether the Present_Value is reliable and why it
     * might be unreliable (e.g., sensor failure, communication failure, etc.).
     */
    readonly reliability: BDSingletProperty<ApplicationTag.ENUMERATED, Reliability>;
    readonly covIncrement: BDSingletProperty<ApplicationTag.REAL>;
    /**
     * Creates a new BACnet Analog Input object
     */
    constructor(instance: number, opts: BDAnalogInputOpts);
}
//# sourceMappingURL=analoginput.d.ts.map