Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/xeto/ph.doc/PointPatterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ found on equipment. This chapter describes the patterns these specs
follow so that points are modeled consistently across equipment and
can be queried by their Xeto types.

# Run and Enable
# Binary Run and Enable
The on/off state of equipment is modeled with [ph.points::RunPoint]:

- [ph.points::RunCmd]: commands equipment to run or stop running
Expand All @@ -26,6 +26,21 @@ conjunction with a run point:
Permission from an enable command may be required for a run command to
take effect.

# Binary Open and Close
The open/close state of two-position equipment, such as an actuator
(e.g., for a damper or valve), a door, or a circuit breaker, is
modeled with [ph.points::OpenPoint]:

- [ph.points::OpenCmd]: commands equipment to open or close
- [ph.points::OpenSensor]: senses the actual open/close state of
equipment

These generic points may be specialized for particular equipment, such
as [ph.points::ActuatorOpenCmd] and [ph.points::ActuatorOpenSensor]
for an actuator. Use the open/close pattern for two-position
equipment, and the modulating pattern below for equipment whose
position varies continuously from 0% to 100%.

# Controlling Equipment Capacity
Equipment with more than simple on/off control varies its capacity
either in discrete stages or by continuous modulation. The two may
Expand Down
6 changes: 6 additions & 0 deletions src/xeto/ph.points/actuator.xeto
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
// 26 Aug 2026 Rick Jennings Creation
//

// Sensor for open/close state of an actuator
ActuatorOpenSensor : OpenSensor { actuator }

// Command for open/close state of an actuator
ActuatorOpenCmd : OpenCmd { actuator }

// Sensor for modulating actuator position. Position is measured as a
// percentage where 0% is closed and 100% is fully open.
ActuatorModulatingSensor : ModulatingSensor { actuator }
Expand Down
15 changes: 15 additions & 0 deletions src/xeto/ph.points/misc.xeto
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,21 @@ HeatEnableCmd : EnableCmd {
stage: Int?
}

// Point associated with the open/close state of equipment
OpenPoint : BoolPoint <abstract> {
open
enum: Obj <val:OpenEnum>
}

// Open and close enumeration
OpenEnum: Enum { close, open }

// Sensor for open/close state of equipment
OpenSensor : OpenPoint & SensorPoint

// Command for open/close state of equipment
OpenCmd : OpenPoint & CmdPoint

// Boolean alarm condition
AlarmSensor : BoolPoint & SensorPoint <abstract> { alarm }

Expand Down