From 7695b80f429dcd95a38d29326138a218cd97d30b Mon Sep 17 00:00:00 2001 From: Patrick McDonagh Date: Wed, 21 Mar 2018 11:56:26 -0500 Subject: [PATCH] Add docs folder for github pages --- README.md | 451 +----------------------------------------------- docs/Mapping.md | 168 ++++++++++++++++++ docs/SCADA.md | 235 +++++++++++++++++++++++++ docs/Wiring.md | 43 +++++ docs/index.md | 14 ++ 5 files changed, 465 insertions(+), 446 deletions(-) create mode 100644 docs/Mapping.md create mode 100644 docs/SCADA.md create mode 100644 docs/Wiring.md create mode 100644 docs/index.md diff --git a/README.md b/README.md index ec478fa..da2a9b0 100644 --- a/README.md +++ b/README.md @@ -1,451 +1,10 @@ -# Pioneer Natural Resources Intelligent Pump Panel -## Developed by Patrick McDonagh, Henry Pump +# PWM Intelligent Pump Panel -# Wiring Guide +Pump Panel for controlling Santa Rosa Water Wells. -## Digital Inputs - -| Input | Device | -|---------- | --------------------- | -| 0 | Legacy Contactor | -| 1 | Legacy HOA Auto | -| 2 | Legacy Start Button | -| 3 | High Pressure Switch | -| 4 | UPS Ready | -| 5 | UPS Buffering | -| 6 | UPS Replace Battery | -| 7 | Lightning Arrestor | +For detailed information see the [project documentation](https://henry-pump.github.io/PWM-IPP). -## Digital Outputs +## Contributors -| Output | Device | -|---------- | --------------------- | -| 0 | Legacy Contactor | - -## Analog Inputs - -| Input | Device | -|---------- | --------------------- | -| 0 | Pressure Transmitter | -| 1 | Flowmeter | - -## E300 Inputs - -| Input | Device | -|---------- | --------------------- | -| 0 | Contactor | -| 1 | Start Button | -| 2 | Auto Mode Switch | -| 3 | Hand Mode Switch | - -## E300 Outputs - -| Output | Device | -|---------- | --------------------- | -| 0 | Contactor | - -# Integer Status Mappings - -## Device Status - -| Integer | String | -|---------- | --------------------------------- | -| 0 | Unknown | -| 1 | Startup | -| 2 | Not Ready to Start | -| 3 | Lost Run Permissive | -| 4 | Running | -| 5 | Contactor Failure, Recovering | -| 6 | Waiting to attempt restart | -| 7 | Waiting to restart after overload | -| 8 | User stopped | - -## Downhole Tool Status - -| Integer | String | -|---------- | --------------------------------- | -| 0 | OK | -| 1 | Connecting | -| 2 | Open Circuit | -| 3 | Shorted | -| 4 | Cannot Decode | -| 5 | Unknown | -| 6 | Disabled | - -## HOA Status - -| Integer | String | -|---------- | --------------------------------- | -| 0 | Auto | -| 1 | Hand | -| 2 | Off | - -## UPS Status - -| Integer | String | -|---------- | --------------------------------- | -| 0 | Ready | -| 1 | Charging | -| 2 | Active | -| 3 | Bad Battery | - -## Current Trip/Warning Status - -| Integer | String | -|---------- | --------------------------------- | -| -1 | OK | -| 0 | Overload | -| 1 | Phase Loss | -| 2 | Ground Fault | -| 3 | Stall | -| 4 | Jam | -| 5 | Underload | -| 6 | Current Imbalance | -| 7 | L1 Undercurrent | -| 8 | L2 Undercurrent | -| 9 | L3 Undercurrent | -| 10 | L1 Overcurrent | -| 11 | L2 Overcurrent | -| 12 | L3 Overcurrent | -| 13 | L1 Line Loss | -| 14 | L2 Line Loss | -| 15 | L3 Line Loss | - -## Voltage Trip/Warning Status - -| Integer | String | -|---------- | --------------------------------- | -| -1 | OK | -| 0 | Undervoltage | -| 1 | Overvoltage | -| 2 | Voltage Imbalance | -| 3 | Phase Rotation | -| 4 | Underfrequency | -| 5 | Overfrequency | - -## Control Trip/Warning Status - -| Integer | String | -|---------- | --------------------------------- | -| -1 | Test | -| 0 | PTC | -| 1 | DeviceLogix | -| 2 | Operator Station | -| 3 | Remote | -| 4 | Blocked Start | -| 5 | Hardware Fault | -| 6 | Config | -| 7 | Option Match | -| 8 | DeviceLogix FB Timeout | -| 9 | Expansion Bus | -| 10 | Reserved | -| 11 | Reserved | -| 12 | Non-Volatile Storage | -| 13 | Test Mode | - -## Power Trip/Warning Status - -| Integer | String | -|---------- | --------------------------------- | -| -1 | OK | -| 0 | Under kW | -| 1 | Over kW | -| 2 | Under kVAR Consumed | -| 3 | Over kVAR Consumed | -| 4 | Under kVAR Generated | -| 5 | Over kVAR Generated | -| 6 | Under kVA | -| 7 | Over kVA | -| 8 | Under PF Lagging | -| 9 | Over PF Lagging | -| 10 | Under PF Leading | -| 11 | Over PF Leading | - -## Overall Device Status - -| Integer | String | -|---------- | --------------------------------- | -| 0 | Running | -| 1 | HOA in Off | -| 2 | Remote Stop | -| 3 | Local Stop | -| 4 | Timer Stop | -| 5 | Downhole Pressure | -| 6 | Downhole Temperature | -| 7 | Tubing Pressure | -| 8 | Low Flow | -| 9 | Current: Overload | -| 10 | Current: Phase Loss | -| 11 | Current: Ground Fault | -| 12 | Current: Stall | -| 13 | Current: Jam | -| 14 | Current: Underload | -| 15 | Current: Current Imbalance | -| 16 | Current: L1 Undercurrent | -| 17 | Current: L2 Undercurrent | -| 18 | Current: L3 Undercurrent | -| 19 | Current: L1 Overcurrent | -| 20 | Current: L2 Overcurrent | -| 21 | Current: L3 Overcurrent | -| 22 | Current: L1 Line Loss | -| 23 | Current: L2 Line Loss | -| 24 | Current: L3 Line Loss | -| 25 | Voltage: Undervoltage | -| 26 | Voltage: Overvoltage | -| 27 | Voltage: Voltage Imbalance | -| 28 | Voltage: Phase Rotation | -| 29 | Voltage: Underfrequency | -| 30 | Voltage: Overfrequency | -| 31 | E300 Hardware Fault | -| 32 | E300 Config | -| 33 | E300 Option Match | -| 34 | E300 Non-Volatile Storage | -| 35 | Power: Under kW | -| 36 | Power: Over kW | -| 37 | Power: Under kVAR Consumed | -| 38 | Power: Over kVAR Consumed | -| 39 | Power: Under kVAR Generated | -| 40 | Power: Over kVAR Generated | -| 41 | Power: Under kVA | -| 42 | Power: Over kVA | -| 43 | Power: Under PF Lagging | -| 44 | Power: Over PF Lagging | -| 45 | Power: Under PF Leading | -| 46 | Power: Over PF Leading | - -# SCADA Tags - -| TYPE | CATEGORY | NAME | DESCRIPTION | DATATYPE | -|-------|------------------|------------------------------------|--------------------------------------------------------------------------|----------| -| TAG | Command | cfg_READ | Read configuration from Energy Monitor | BOOL | -| TAG | Command | cfg_WRITE | Write configuration to Energy Monitor | BOOL | -| TAG | Command | SCADA_ALM_RESET | Reset All Alarms | BOOL | -| TAG | Command | SCADA_START_PUMP_BIT | Start from SCADA | BOOL | -| TAG | Command | SCADA_STOP_PUMP_BIT | Stop from SCADA | BOOL | -| TAG | Command | Set_Default_E300_Configuration | Set E300 to Default Configurations | BOOL | -| TAG | Command | Set_PLC_Time | Command to set PLC time | BOOL | -| TAG | Command | Start_Command | Start Command | BOOL | -| TAG | Command | Stop_Command | Stop Command | BOOL | -| ALIAS | Command | TripResetCmd | Trip Reset Command | BOOL | -| TAG | Device Config | cfg_DHSensorDistToIntake | Feet from Sensor to Pump Intake | REAL | -| TAG | Device Config | cfg_E300_Disabled | Energy Monitor is Disabled | BOOL | -| TAG | Device Config | cfg_SpecificGravity | Fluid Specific Gravity | REAL | -| TAG | Device Config | DH_Pressure_Shutdown | | REAL | -| TAG | Device Config | DH_Pressure_Shutdown_Enabled | | BOOL | -| TAG | Device Config | DH_Pressure_Startup | | REAL | -| TAG | Device Config | DH_Pressure_Startup_Enabled | | BOOL | -| TAG | Device Config | DH_Temp_Shutdown | | REAL | -| TAG | Device Config | DH_Temp_Shutdown_Enabled | | BOOL | -| TAG | Device Config | DH_Temp_Startup | | REAL | -| TAG | Device Config | DH_Temp_Startup_Enabled | | BOOL | -| TAG | Device Config | Downtime_Time_Parameter | Seconds to wait while tripped for any reason other than Overload | DINT | -| TAG | Device Config | Downtime_Time_Parameter_OL | Seconds to wait while tripped for Overload | DINT | -| TAG | Device Config | HI_PSI_ALM_SETPOINT | High Tubing Pressure Alarm Setpoint | REAL | -| TAG | Device Config | Input_DateTime.Day | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Hour | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Microsecond | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Minute | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Month | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Second | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | Input_DateTime.Year | Datetime for setting PLC Datetime from SCADA | DINT | -| TAG | Device Config | LO_FLOW_ALM_SETPOINT | Low Flow Alarm Setpoint | REAL | -| TAG | Device Config | LO_PSI_ALM_SETPOINT | Low Tubing Pressure Alarm Setpoint | REAL | -| TAG | Device Status | Auto_Mode | Auto Mode | BOOL | -| TAG | Device Status | Contactor_Status | Contactor Status | BOOL | -| TAG | Device Status | DATETIME.Day | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Hour | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Microsecond | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Minute | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Month | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Second | Current Controller Datetime | DINT | -| TAG | Device Status | DATETIME.Year | Current Controller Datetime | DINT | -| TAG | Device Status | Device_Status | Device Status String | STRING | -| TAG | Device Status | Device_Status_INT | Integer for Device Status Indication | DINT | -| TAG | Device Status | DH_DownholeStatus | Downhole Monitor Status | STRING | -| TAG | Device Status | DH_DownholeStatus_INT | Integer for Downhole Monitor Status | INT | -| TAG | Device Status | Downhole_Tool_Enabled | Downhole Monitor is Enabled | BOOL | -| ALIAS | Device Status | E300_Auto_Mode_Switch | Auto Mode Switch Input 02 on E300 | BOOL | -| ALIAS | Device Status | E300_Contactor_Input | Contactor Status Input 00 on E300 | BOOL | -| ALIAS | Device Status | E300_Hand_Mode_Switch | Hand Mode Switch Input 03 on E300 | BOOL | -| ALIAS | Device Status | E300_Start_Button | Start Button Input 01 on E300 | BOOL | -| TAG | Device Status | Hand_Mode | Hand Mode | BOOL | -| TAG | Device Status | HI_PSI_SHUTDOWN_ALM | High Tubing Pressure Alarm Active | BOOL | -| ALIAS | Device Status | High_Pressure_Switch | High Pressure Switch, Fail-Low, (1 = OK) | BOOL | -| TAG | Device Status | HOA_Status | HOA position (0 = Auto, 1 = Hand, 2 = Off) | BOOL | -| TAG | Device Status | Lightning_Arrestor_Tripped | Lighning Arrestor is Tripped | BOOL | -| TAG | Device Status | LO_FLOW_ALM | Low Flow Alarm Active | BOOL | -| TAG | Device Status | LO_PSI_SHUTDOWN_ALM | Low Tubing Pressure Alarm Active | BOOL | -| TAG | Device Status | Off_Mode | Off Mode | BOOL | -| TAG | Device Status | Overall_Trip_Status | Overall Trip Status (Mapped from Overall_Trip_Status_INT) | STRING | -| TAG | Device Status | Overall_Trip_Status_INT | Overall Trip Status Integer | DINT | -| TAG | Device Status | Overall_Trip_Status_Timestamp | Overall Trip Status Timestamp | STRING | -| TAG | Device Status | Overall_Warning_Status | Overall Warning Status (Mapped from Overall_Warning_Status) | STRING | -| TAG | Device Status | Overall_Warning_Status_INT | Overall Warning Status Integer | DINT | -| TAG | Device Status | Time_Until_Startup | Seconds until device startup | DINT | -| TAG | Device Status | TubingPressure | Scaled Tubing Pressure Measurment | REAL | -| ALIAS | Device Status | UPS_Buffering | UPS is Buffering. | BOOL | -| ALIAS | Device Status | UPS_Ready | UPS is Ready | BOOL | -| ALIAS | Device Status | UPS_ReplaceBattery | UPS Battery needs Replacing | BOOL | -| TAG | Device Status | UPS_Status_INT | UPS Status Integer | DINT | -| TAG | Device Status | UPS_Status | UPS Status String (mapped from UPS_Status_INT) | STRING | -| TAG | Downhole Monitor | DH_Fluid_Level | Fluid Level above the Pump Intake | REAL | -| TAG | Downhole Monitor | DH_IntakePressure | Pump Intake Pressure (measured at sensor) | REAL | -| TAG | Downhole Monitor | DH_IntakeTemperature | Pump Intake Temperature | REAL | -| TAG | Downhole Monitor | DH_Pressure_Offset | Ambient Pressure Offset | REAL | -| TAG | Downhole Monitor | DH_PSIRating | PSI Rating of Instrument (/1000) | DINT | -| TAG | Energy Config | cfg_GF_GroundFaultInhibitTime | Ground Fault Inhibit Time | SINT | -| TAG | Energy Config | cfg_GF_GroundFaultTripDelay | Ground Fault Trip Delay | REAL | -| TAG | Energy Config | cfg_GF_GroundFaultTripLevel | Ground Fault Trip Level | REAL | -| TAG | Energy Config | cfg_GF_GroundFaultWarningDelay | Ground Fault Warning Delay | REAL | -| TAG | Energy Config | cfg_GF_GroundFaultWarningLevel | Ground Fault Warning Level | REAL | -| TAG | Energy Config | cfg_I_CTPrimary | Current Transformer Primary Ratio | INT | -| TAG | Energy Config | cfg_I_CTSecondary | Current Transformer Secondary Ratio | INT | -| TAG | Energy Config | cfg_I_CurrentImbalanceInhibitTime | Current Imbalance Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_CurrentImbalanceTripDelay | Current Imbalance Trip Delay | REAL | -| TAG | Energy Config | cfg_I_CurrentImbalanceTripLevel | Current Imbalance Trip Level | SINT | -| TAG | Energy Config | cfg_I_CurrentImbalanceWarningLevel | Current Imbalance Warning Level | SINT | -| TAG | Energy Config | cfg_I_FLASetting | Motor FLA | REAL | -| TAG | Energy Config | cfg_I_JamInhibitTime | Jam Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_JamTripDelay | Jam Trip Delay | REAL | -| TAG | Energy Config | cfg_I_JamTripLevel | Jam Trip Level | INT | -| TAG | Energy Config | cfg_I_JamWarningLevel | Jam Warning Level | INT | -| TAG | Energy Config | cfg_I_LineLossInhibitTime | Line Loss Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_LineLossTripDelay | Line Loss Trip Delay | REAL | -| TAG | Energy Config | cfg_I_OvercurrentInhibitTime | Overcurrent Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_OvercurrentTripDelay | Overcurrent Trip Delay | REAL | -| TAG | Energy Config | cfg_I_OvercurrentTripLevel | Overcurrent Trip Level | SINT | -| TAG | Energy Config | cfg_I_OvercurrentWarningLevel | Overcurrent Warning Level | SINT | -| TAG | Energy Config | cfg_I_StallEnabledTime | Stall Enabled Time | SINT | -| TAG | Energy Config | cfg_I_StallTripLevel | Stall Trip Level | INT | -| TAG | Energy Config | cfg_I_UndercurrentInhibitTime | Undercurrent Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_UndercurrentTripDelay | Undercurrent Trip Delay | REAL | -| TAG | Energy Config | cfg_I_UndercurrentTripLevel | Undercurrent Trip Level | SINT | -| TAG | Energy Config | cfg_I_UndercurrentWarningLevel | Undercurrent Warning Level | SINT | -| TAG | Energy Config | cfg_I_UnderloadInhibitTime | Underload Inhibit Time | SINT | -| TAG | Energy Config | cfg_I_UnderloadTripDelay | Underload Trip Delay | REAL | -| TAG | Energy Config | cfg_I_UnderloadTripLevel | Underload Trip Level | SINT | -| TAG | Energy Config | cfg_I_UnderloadWarningLevel | Underload Warning Level | SINT | -| TAG | Energy Config | cfg_PL_PhaseLossInhibitTime | Phase Loss Inhibit Time | SINT | -| TAG | Energy Config | cfg_PL_PhaseLossTripDelay | Phase Loss Trip Delay | REAL | -| TAG | Device Config | cfg_PressureSwitchDisabled | High Pressure Switch is Disabled | BOOL | -| TAG | Energy Config | cfg_TCU_OLResetLevel | Thermal Capacity Utilization Overload Reset Level | SINT | -| TAG | Energy Config | cfg_TCU_OLWarningLevel | Thermal Capacity Utilization Overload Warning Level | SINT | -| TAG | Energy Config | cfg_TCU_TripClass | Thermal Capacity Utilization Trip Class | SINT | -| TAG | Energy Config | cfg_V_OverfrequencyInhibitTime | Overfrequency Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_OverfrequencyTripDelay | Overfrequency Trip Delay | REAL | -| TAG | Energy Config | cfg_V_OverfrequencyTripLevel | Overfrequency Trip Level | SINT | -| TAG | Energy Config | cfg_V_OverfrequencyWarningLevel | Overfrequency Warning Level | SINT | -| TAG | Energy Config | cfg_V_OvervoltageInhibitTime | Overvoltage Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_OvervoltageTripDelay | Overvoltage Trip Delay | REAL | -| TAG | Energy Config | cfg_V_OvervoltageTripLevel | Overvoltage Trip Level | REAL | -| TAG | Energy Config | cfg_V_OvervoltageWarningLevel | Overvoltage Warning Level | REAL | -| TAG | Energy Config | cfg_V_PhaseRotationInhibitTime | Phase Rotation Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_PhaseRotationTripType | Phase Rotation Trip Type (0 = ABC, 1 = ACB) | SINT | -| TAG | Energy Config | cfg_V_PTPrimary | Potential Transformer Primary Ratio | INT | -| TAG | Energy Config | cfg_V_PTSecondary | Potential Transformer Secondary Ratio | INT | -| TAG | Energy Config | cfg_V_UnderfrequencyInhibitTime | Underfrequency Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_UnderfrequencyTripDelay | Underfrequency Trip Delay | REAL | -| TAG | Energy Config | cfg_V_UnderfrequencyTripLevel | Underfrequency Trip Level | SINT | -| TAG | Energy Config | cfg_V_UnderfrequencyWarningLevel | Underfrequency Warning Level | SINT | -| TAG | Energy Config | cfg_V_UndervoltageInhibitTime | Undervoltage Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_UndervoltageTripDelay | Undervoltage Trip Delay | REAL | -| TAG | Energy Config | cfg_V_UndervoltageTripLevel | Undervoltage Trip Level | REAL | -| TAG | Energy Config | cfg_V_UndervoltageWarningLevel | Undervoltage Warning Level | REAL | -| TAG | Energy Config | cfg_V_VoltageImbalanceInhibitTime | Voltage Imbalance Inhibit Time | SINT | -| TAG | Energy Config | cfg_V_VoltageImbalanceTripDelay | Voltage Imbalance Trip Delay | REAL | -| TAG | Energy Config | cfg_V_VoltageImbalanceTripLevel | Voltage Imbalance Trip Level | SINT | -| TAG | Energy Config | cfg_V_VoltageImbalanceWarningLevel | Voltage Imalance Warning Level | SINT | -| TAG | Energy Config | cfg_V_VoltageMode | Voltage Mode ( ) | SINT | -| TAG | Energy Config | TripEnable_I_CurrentImbalance | Current Imbalance Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_GroundFault | Ground Fault Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Jam | Jam Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_LineLoss | Line Loss Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Overcurrent | Overcurrent Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Overload | Overload Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_PhaseLoss | Phase Loss Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Stall | Stall Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Undercurrent | Undercurrent Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_I_Underload | Underload Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_Overfrequency | Overfrequency Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_Overvoltage | Overvoltage Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_PhaseRotation | Phase Rotation Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_Underfrequency | Underfrequency Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_Undervoltage | Undervoltage Trip Enabled | BOOL | -| TAG | Energy Config | TripEnable_V_VoltageUnbalance | Voltage Imbalance Trip Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_CurrentImbalance | Current Imbalance Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_GroundFault | Ground Fault Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_Jam | Jam Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_LineLoss | Line Loss Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_Overcurrent | Overcurrent Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_Overload | Overload Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_Undercurrent | Undercurrent Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_I_Underload | Underload Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_Overfrequency | Overfrequency Wanring Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_Overvoltage | Overvoltage Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_PhaseRotation | Phase Rotation Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_Underfrequency | Underfrequency Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_Undervoltage | Undervoltage Warning Enabled | BOOL | -| TAG | Energy Config | WarningEnable_V_VoltageUnbalance | Voltage Imbalance Warning Enabled | BOOL | -| TAG | Energy Status | E300_AverageCurrent | Average Current | REAL | -| TAG | Energy Status | E300_AverageLLVoltage | Average Line-to-Line Voltage | REAL | -| TAG | Energy Status | E300_ControlTripBit | Control Trip Status Integer (-1 = No Trip) | DINT | -| TAG | Energy Status | E300_ControlTripStatus | Control Trip Status | STRING | -| TAG | Energy Status | E300_ControlWarningBit | Control Warning Status Integer (-1 = No Warning) | DINT | -| TAG | Energy Status | E300_ControlWarningStatus | Control Warning Status | STRING | -| TAG | Energy Status | E300_CurrentTripBit | Current Trip Status Integers (-1 = No Trip) | DINT | -| TAG | Energy Status | E300_CurrentTripStatus | Current Trip Status | STRING | -| TAG | Energy Status | E300_CurrentWarningBit | Current Warning Status Integer (-1= No Warning) | DINT | -| TAG | Energy Status | E300_CurrentWarningStatus | Current Warning Status | STRING | -| TAG | Energy Status | E300_L1Current | L1 Current | REAL | -| TAG | Energy Status | E300_L1L2Voltage | L1-L2 Voltage | REAL | -| TAG | Energy Status | E300_L2Current | L2 Current | REAL | -| TAG | Energy Status | E300_L2L3Voltage | L2-L3 Voltage | REAL | -| TAG | Energy Status | E300_L3Current | L3 Current | REAL | -| TAG | Energy Status | E300_L3L1Voltage | L3-L1 Voltage | REAL | -| TAG | Energy Status | E300_LineFrequency | Line Frequency | REAL | -| TAG | Energy Status | E300_PercentCurrentUnbalance | Percent Current Imbalance | REAL | -| TAG | Energy Status | E300_PercentVoltageUnbalance | Percent Voltage Imbalance | REAL | -| TAG | Energy Status | E300_PhaseRotation | Phase Rotation (String) | STRING | -| TAG | Energy Status | E300_PhaseRotation_INT | Phase Rotation Integer | DINT | -| TAG | Energy Status | E300_PowerTripBit | Power Trip Status Integer (-1 = No Trip) | DINT | -| TAG | Energy Status | E300_PowerTripStatus | Power Trip Status | STRING | -| TAG | Energy Status | E300_PowerWarningBit | Power Warning Status Integer (-1 = No Warning) | DINT | -| TAG | Energy Status | E300_PowerWarningStatus | Power Warning Status | STRING | -| TAG | Energy Status | E300_ThreePhaseTruePowerFactor | True 3-Phase Power Factor | REAL | -| TAG | Energy Status | E300_TotalApparentPower | Total Apparent Power (kVA) | REAL | -| TAG | Energy Status | E300_TotalReactivePower | Total Reactive Power (kVAR) | REAL | -| TAG | Energy Status | E300_TotalRealPower | Total Real Power (kW) | REAL | -| TAG | Energy Status | E300_VoltageTripBit | Voltage Trip Status Integer (-1 = No Trip) | DINT | -| TAG | Energy Status | E300_VoltageTripStatus | Voltage Trip Status | STRING | -| TAG | Energy Status | E300_VoltageWarningBit | Voltage Warning Status Integer (-1 = No Warning) | DINT | -| TAG | Energy Status | E300_VoltageWarningStatus | Voltage Warning Status | STRING | -| ALIAS | Energy Status | TripStatus | Trip Present | BOOL | -| TAG | Energy Status | VoltageOK | Voltage is within the tolerable Limits | BOOL | -| TAG | Flow | FlowRate | Scaled Flow Rate | REAL | -| ALIAS | Flow | Flowmeter_HART_Failure | Communication Failure between HART card and Flowmeter | BOOL | -| TAG | Flow | LASTMONTH_TOTAL_BBL | Last Month Total BBL | REAL | -| TAG | Flow | LASTMONTH_TOTAL_RUN_TIME_HOURS | Last Month Total Runtime Hours | REAL | -| TAG | Flow | THISMONTH_TOTAL_BBL | This Month Total BBL | REAL | -| TAG | Flow | THISMONTH_TOTAL_RUN_TIME_HOURS | This Month Total Runtime Hours | REAL | -| TAG | Flow | TODAY_TOTAL_BBL | Today's Total BBL | REAL | -| TAG | Flow | TODAY_TOTAL_RUN_TIME_HOURS | Today's Total Runtime Hours | REAL | -| TAG | Flow | YESTERDAY_TOTAL_BBL | Yesterday's Total BBL | REAL | -| TAG | Flow | YESTERDAY_TOTAL_RUN_TIME_HOURS | Testerday's Total Runtime Hours | REAL | -| TAG | Permissive | RP_Flow | Run not prevented by Flow | BOOL | -| TAG | Permissive | RP_Mode | Run not prevented by Mode | BOOL | -| TAG | Permissive | RP_Pressure | Run not prevented by Downhole Pressure | BOOL | -| TAG | Permissive | RP_Remote | Run not prevented by Remote Trip | BOOL | -| TAG | Permissive | RP_Temperature | Run not prevented by Downhole Temperature | BOOL | -| TAG | Permissive | RP_Trip | Run not prevented by Energy Trip | BOOL | -| TAG | Permissive | RP_TubingPressure | Run not prevented by Tubing Pressure | BOOL | -| TAG | Permissive | Run_Permissive | Run not prevented | BOOL | -| TAG | Permissive | SP_Mode | Startup not prevented by Mode | BOOL | -| TAG | Permissive | SP_Pressure | Startup not prevented by Downhole Pressure | BOOL | -| TAG | Permissive | SP_Remote | Startup not prevented by Remote Trip | BOOL | -| TAG | Permissive | SP_Temperature | Startup not prevented by Downhole Temperature | BOOL | -| TAG | Permissive | SP_Trip | Startup not prevented by Energy Trip | BOOL | -| TAG | Permissive | SP_Voltage | Startup not prevented by Voltage | BOOL | -| TAG | Permissive | Start_Permissive | Startup not prevented | BOOL | -| TAG | Watchdog | datalogger_watchdog | DataLogger Handshake: Datalogger will write 1 to this tag when it sees 0 | BOOL | -| TAG | Watchdog | Datalogger_Watchdog_Timeout | The datalogger is not communicating with the PLC | BOOL | +- [Patrick McDonagh](https://github.com/patrickjmcd) diff --git a/docs/Mapping.md b/docs/Mapping.md new file mode 100644 index 0000000..693fe04 --- /dev/null +++ b/docs/Mapping.md @@ -0,0 +1,168 @@ +# Integer Status Mappings + +## Device Status + +| Integer | String | +|---------- | --------------------------------- | +| 0 | Unknown | +| 1 | Startup | +| 2 | Not Ready to Start | +| 3 | Lost Run Permissive | +| 4 | Running | +| 5 | Contactor Failure, Recovering | +| 6 | Waiting to attempt restart | +| 7 | Waiting to restart after overload | +| 8 | User stopped | + +## Downhole Tool Status + +| Integer | String | +|---------- | --------------------------------- | +| 0 | OK | +| 1 | Connecting | +| 2 | Open Circuit | +| 3 | Shorted | +| 4 | Cannot Decode | +| 5 | Unknown | +| 6 | Disabled | + +## HOA Status + +| Integer | String | +|---------- | --------------------------------- | +| 0 | Auto | +| 1 | Hand | +| 2 | Off | + +## UPS Status + +| Integer | String | +|---------- | --------------------------------- | +| 0 | Ready | +| 1 | Charging | +| 2 | Active | +| 3 | Bad Battery | + +## Current Trip/Warning Status + +| Integer | String | +|---------- | --------------------------------- | +| -1 | OK | +| 0 | Overload | +| 1 | Phase Loss | +| 2 | Ground Fault | +| 3 | Stall | +| 4 | Jam | +| 5 | Underload | +| 6 | Current Imbalance | +| 7 | L1 Undercurrent | +| 8 | L2 Undercurrent | +| 9 | L3 Undercurrent | +| 10 | L1 Overcurrent | +| 11 | L2 Overcurrent | +| 12 | L3 Overcurrent | +| 13 | L1 Line Loss | +| 14 | L2 Line Loss | +| 15 | L3 Line Loss | + +## Voltage Trip/Warning Status + +| Integer | String | +|---------- | --------------------------------- | +| -1 | OK | +| 0 | Undervoltage | +| 1 | Overvoltage | +| 2 | Voltage Imbalance | +| 3 | Phase Rotation | +| 4 | Underfrequency | +| 5 | Overfrequency | + +## Control Trip/Warning Status + +| Integer | String | +|---------- | --------------------------------- | +| -1 | Test | +| 0 | PTC | +| 1 | DeviceLogix | +| 2 | Operator Station | +| 3 | Remote | +| 4 | Blocked Start | +| 5 | Hardware Fault | +| 6 | Config | +| 7 | Option Match | +| 8 | DeviceLogix FB Timeout | +| 9 | Expansion Bus | +| 10 | Reserved | +| 11 | Reserved | +| 12 | Non-Volatile Storage | +| 13 | Test Mode | + +## Power Trip/Warning Status + +| Integer | String | +|---------- | --------------------------------- | +| -1 | OK | +| 0 | Under kW | +| 1 | Over kW | +| 2 | Under kVAR Consumed | +| 3 | Over kVAR Consumed | +| 4 | Under kVAR Generated | +| 5 | Over kVAR Generated | +| 6 | Under kVA | +| 7 | Over kVA | +| 8 | Under PF Lagging | +| 9 | Over PF Lagging | +| 10 | Under PF Leading | +| 11 | Over PF Leading | + +## Overall Device Status + +| Integer | String | +|---------- | --------------------------------- | +| 0 | Running | +| 1 | HOA in Off | +| 2 | Remote Stop | +| 3 | Local Stop | +| 4 | Timer Stop | +| 5 | Downhole Pressure | +| 6 | Downhole Temperature | +| 7 | Tubing Pressure | +| 8 | Low Flow | +| 9 | Current: Overload | +| 10 | Current: Phase Loss | +| 11 | Current: Ground Fault | +| 12 | Current: Stall | +| 13 | Current: Jam | +| 14 | Current: Underload | +| 15 | Current: Current Imbalance | +| 16 | Current: L1 Undercurrent | +| 17 | Current: L2 Undercurrent | +| 18 | Current: L3 Undercurrent | +| 19 | Current: L1 Overcurrent | +| 20 | Current: L2 Overcurrent | +| 21 | Current: L3 Overcurrent | +| 22 | Current: L1 Line Loss | +| 23 | Current: L2 Line Loss | +| 24 | Current: L3 Line Loss | +| 25 | Voltage: Undervoltage | +| 26 | Voltage: Overvoltage | +| 27 | Voltage: Voltage Imbalance | +| 28 | Voltage: Phase Rotation | +| 29 | Voltage: Underfrequency | +| 30 | Voltage: Overfrequency | +| 31 | E300 Hardware Fault | +| 32 | E300 Config | +| 33 | E300 Option Match | +| 34 | E300 Non-Volatile Storage | +| 35 | Power: Under kW | +| 36 | Power: Over kW | +| 37 | Power: Under kVAR Consumed | +| 38 | Power: Over kVAR Consumed | +| 39 | Power: Under kVAR Generated | +| 40 | Power: Over kVAR Generated | +| 41 | Power: Under kVA | +| 42 | Power: Over kVA | +| 43 | Power: Under PF Lagging | +| 44 | Power: Over PF Lagging | +| 45 | Power: Under PF Leading | +| 46 | Power: Over PF Leading | diff --git a/docs/SCADA.md b/docs/SCADA.md new file mode 100644 index 0000000..562189c --- /dev/null +++ b/docs/SCADA.md @@ -0,0 +1,235 @@ +# SCADA Tags + +| TYPE | CATEGORY | NAME | DESCRIPTION | DATATYPE | +|-------|------------------|------------------------------------|--------------------------------------------------------------------------|----------| +| TAG | Command | cfg_READ | Read configuration from Energy Monitor | BOOL | +| TAG | Command | cfg_WRITE | Write configuration to Energy Monitor | BOOL | +| TAG | Command | SCADA_ALM_RESET | Reset All Alarms | BOOL | +| TAG | Command | SCADA_START_PUMP_BIT | Start from SCADA | BOOL | +| TAG | Command | SCADA_STOP_PUMP_BIT | Stop from SCADA | BOOL | +| TAG | Command | Set_Default_E300_Configuration | Set E300 to Default Configurations | BOOL | +| TAG | Command | Set_PLC_Time | Command to set PLC time | BOOL | +| TAG | Command | Start_Command | Start Command | BOOL | +| TAG | Command | Stop_Command | Stop Command | BOOL | +| ALIAS | Command | TripResetCmd | Trip Reset Command | BOOL | +| TAG | Device Config | cfg_DHSensorDistToIntake | Feet from Sensor to Pump Intake | REAL | +| TAG | Device Config | cfg_E300_Disabled | Energy Monitor is Disabled | BOOL | +| TAG | Device Config | cfg_SpecificGravity | Fluid Specific Gravity | REAL | +| TAG | Device Config | DH_Pressure_Shutdown | | REAL | +| TAG | Device Config | DH_Pressure_Shutdown_Enabled | | BOOL | +| TAG | Device Config | DH_Pressure_Startup | | REAL | +| TAG | Device Config | DH_Pressure_Startup_Enabled | | BOOL | +| TAG | Device Config | DH_Temp_Shutdown | | REAL | +| TAG | Device Config | DH_Temp_Shutdown_Enabled | | BOOL | +| TAG | Device Config | DH_Temp_Startup | | REAL | +| TAG | Device Config | DH_Temp_Startup_Enabled | | BOOL | +| TAG | Device Config | Downtime_Time_Parameter | Seconds to wait while tripped for any reason other than Overload | DINT | +| TAG | Device Config | Downtime_Time_Parameter_OL | Seconds to wait while tripped for Overload | DINT | +| TAG | Device Config | HI_PSI_ALM_SETPOINT | High Tubing Pressure Alarm Setpoint | REAL | +| TAG | Device Config | Input_DateTime.Day | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Hour | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Microsecond | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Minute | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Month | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Second | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | Input_DateTime.Year | Datetime for setting PLC Datetime from SCADA | DINT | +| TAG | Device Config | LO_FLOW_ALM_SETPOINT | Low Flow Alarm Setpoint | REAL | +| TAG | Device Config | LO_PSI_ALM_SETPOINT | Low Tubing Pressure Alarm Setpoint | REAL | +| TAG | Device Status | Auto_Mode | Auto Mode | BOOL | +| TAG | Device Status | Contactor_Status | Contactor Status | BOOL | +| TAG | Device Status | DATETIME.Day | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Hour | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Microsecond | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Minute | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Month | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Second | Current Controller Datetime | DINT | +| TAG | Device Status | DATETIME.Year | Current Controller Datetime | DINT | +| TAG | Device Status | Device_Status | Device Status String | STRING | +| TAG | Device Status | Device_Status_INT | Integer for Device Status Indication | DINT | +| TAG | Device Status | DH_DownholeStatus | Downhole Monitor Status | STRING | +| TAG | Device Status | DH_DownholeStatus_INT | Integer for Downhole Monitor Status | INT | +| TAG | Device Status | Downhole_Tool_Enabled | Downhole Monitor is Enabled | BOOL | +| ALIAS | Device Status | E300_Auto_Mode_Switch | Auto Mode Switch Input 02 on E300 | BOOL | +| ALIAS | Device Status | E300_Contactor_Input | Contactor Status Input 00 on E300 | BOOL | +| ALIAS | Device Status | E300_Hand_Mode_Switch | Hand Mode Switch Input 03 on E300 | BOOL | +| ALIAS | Device Status | E300_Start_Button | Start Button Input 01 on E300 | BOOL | +| TAG | Device Status | Hand_Mode | Hand Mode | BOOL | +| TAG | Device Status | HI_PSI_SHUTDOWN_ALM | High Tubing Pressure Alarm Active | BOOL | +| ALIAS | Device Status | High_Pressure_Switch | High Pressure Switch, Fail-Low, (1 = OK) | BOOL | +| TAG | Device Status | HOA_Status | HOA position (0 = Auto, 1 = Hand, 2 = Off) | BOOL | +| TAG | Device Status | Lightning_Arrestor_Tripped | Lighning Arrestor is Tripped | BOOL | +| TAG | Device Status | LO_FLOW_ALM | Low Flow Alarm Active | BOOL | +| TAG | Device Status | LO_PSI_SHUTDOWN_ALM | Low Tubing Pressure Alarm Active | BOOL | +| TAG | Device Status | Off_Mode | Off Mode | BOOL | +| TAG | Device Status | Overall_Trip_Status | Overall Trip Status (Mapped from Overall_Trip_Status_INT) | STRING | +| TAG | Device Status | Overall_Trip_Status_INT | Overall Trip Status Integer | DINT | +| TAG | Device Status | Overall_Trip_Status_Timestamp | Overall Trip Status Timestamp | STRING | +| TAG | Device Status | Overall_Warning_Status | Overall Warning Status (Mapped from Overall_Warning_Status) | STRING | +| TAG | Device Status | Overall_Warning_Status_INT | Overall Warning Status Integer | DINT | +| TAG | Device Status | Time_Until_Startup | Seconds until device startup | DINT | +| TAG | Device Status | TubingPressure | Scaled Tubing Pressure Measurment | REAL | +| ALIAS | Device Status | UPS_Buffering | UPS is Buffering. | BOOL | +| ALIAS | Device Status | UPS_Ready | UPS is Ready | BOOL | +| ALIAS | Device Status | UPS_ReplaceBattery | UPS Battery needs Replacing | BOOL | +| TAG | Device Status | UPS_Status_INT | UPS Status Integer | DINT | +| TAG | Device Status | UPS_Status | UPS Status String (mapped from UPS_Status_INT) | STRING | +| TAG | Downhole Monitor | DH_Fluid_Level | Fluid Level above the Pump Intake | REAL | +| TAG | Downhole Monitor | DH_IntakePressure | Pump Intake Pressure (measured at sensor) | REAL | +| TAG | Downhole Monitor | DH_IntakeTemperature | Pump Intake Temperature | REAL | +| TAG | Downhole Monitor | DH_Pressure_Offset | Ambient Pressure Offset | REAL | +| TAG | Downhole Monitor | DH_PSIRating | PSI Rating of Instrument (/1000) | DINT | +| TAG | Energy Config | cfg_GF_GroundFaultInhibitTime | Ground Fault Inhibit Time | SINT | +| TAG | Energy Config | cfg_GF_GroundFaultTripDelay | Ground Fault Trip Delay | REAL | +| TAG | Energy Config | cfg_GF_GroundFaultTripLevel | Ground Fault Trip Level | REAL | +| TAG | Energy Config | cfg_GF_GroundFaultWarningDelay | Ground Fault Warning Delay | REAL | +| TAG | Energy Config | cfg_GF_GroundFaultWarningLevel | Ground Fault Warning Level | REAL | +| TAG | Energy Config | cfg_I_CTPrimary | Current Transformer Primary Ratio | INT | +| TAG | Energy Config | cfg_I_CTSecondary | Current Transformer Secondary Ratio | INT | +| TAG | Energy Config | cfg_I_CurrentImbalanceInhibitTime | Current Imbalance Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_CurrentImbalanceTripDelay | Current Imbalance Trip Delay | REAL | +| TAG | Energy Config | cfg_I_CurrentImbalanceTripLevel | Current Imbalance Trip Level | SINT | +| TAG | Energy Config | cfg_I_CurrentImbalanceWarningLevel | Current Imbalance Warning Level | SINT | +| TAG | Energy Config | cfg_I_FLASetting | Motor FLA | REAL | +| TAG | Energy Config | cfg_I_JamInhibitTime | Jam Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_JamTripDelay | Jam Trip Delay | REAL | +| TAG | Energy Config | cfg_I_JamTripLevel | Jam Trip Level | INT | +| TAG | Energy Config | cfg_I_JamWarningLevel | Jam Warning Level | INT | +| TAG | Energy Config | cfg_I_LineLossInhibitTime | Line Loss Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_LineLossTripDelay | Line Loss Trip Delay | REAL | +| TAG | Energy Config | cfg_I_OvercurrentInhibitTime | Overcurrent Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_OvercurrentTripDelay | Overcurrent Trip Delay | REAL | +| TAG | Energy Config | cfg_I_OvercurrentTripLevel | Overcurrent Trip Level | SINT | +| TAG | Energy Config | cfg_I_OvercurrentWarningLevel | Overcurrent Warning Level | SINT | +| TAG | Energy Config | cfg_I_StallEnabledTime | Stall Enabled Time | SINT | +| TAG | Energy Config | cfg_I_StallTripLevel | Stall Trip Level | INT | +| TAG | Energy Config | cfg_I_UndercurrentInhibitTime | Undercurrent Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_UndercurrentTripDelay | Undercurrent Trip Delay | REAL | +| TAG | Energy Config | cfg_I_UndercurrentTripLevel | Undercurrent Trip Level | SINT | +| TAG | Energy Config | cfg_I_UndercurrentWarningLevel | Undercurrent Warning Level | SINT | +| TAG | Energy Config | cfg_I_UnderloadInhibitTime | Underload Inhibit Time | SINT | +| TAG | Energy Config | cfg_I_UnderloadTripDelay | Underload Trip Delay | REAL | +| TAG | Energy Config | cfg_I_UnderloadTripLevel | Underload Trip Level | SINT | +| TAG | Energy Config | cfg_I_UnderloadWarningLevel | Underload Warning Level | SINT | +| TAG | Energy Config | cfg_PL_PhaseLossInhibitTime | Phase Loss Inhibit Time | SINT | +| TAG | Energy Config | cfg_PL_PhaseLossTripDelay | Phase Loss Trip Delay | REAL | +| TAG | Device Config | cfg_PressureSwitchDisabled | High Pressure Switch is Disabled | BOOL | +| TAG | Energy Config | cfg_TCU_OLResetLevel | Thermal Capacity Utilization Overload Reset Level | SINT | +| TAG | Energy Config | cfg_TCU_OLWarningLevel | Thermal Capacity Utilization Overload Warning Level | SINT | +| TAG | Energy Config | cfg_TCU_TripClass | Thermal Capacity Utilization Trip Class | SINT | +| TAG | Energy Config | cfg_V_OverfrequencyInhibitTime | Overfrequency Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_OverfrequencyTripDelay | Overfrequency Trip Delay | REAL | +| TAG | Energy Config | cfg_V_OverfrequencyTripLevel | Overfrequency Trip Level | SINT | +| TAG | Energy Config | cfg_V_OverfrequencyWarningLevel | Overfrequency Warning Level | SINT | +| TAG | Energy Config | cfg_V_OvervoltageInhibitTime | Overvoltage Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_OvervoltageTripDelay | Overvoltage Trip Delay | REAL | +| TAG | Energy Config | cfg_V_OvervoltageTripLevel | Overvoltage Trip Level | REAL | +| TAG | Energy Config | cfg_V_OvervoltageWarningLevel | Overvoltage Warning Level | REAL | +| TAG | Energy Config | cfg_V_PhaseRotationInhibitTime | Phase Rotation Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_PhaseRotationTripType | Phase Rotation Trip Type (0 = ABC, 1 = ACB) | SINT | +| TAG | Energy Config | cfg_V_PTPrimary | Potential Transformer Primary Ratio | INT | +| TAG | Energy Config | cfg_V_PTSecondary | Potential Transformer Secondary Ratio | INT | +| TAG | Energy Config | cfg_V_UnderfrequencyInhibitTime | Underfrequency Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_UnderfrequencyTripDelay | Underfrequency Trip Delay | REAL | +| TAG | Energy Config | cfg_V_UnderfrequencyTripLevel | Underfrequency Trip Level | SINT | +| TAG | Energy Config | cfg_V_UnderfrequencyWarningLevel | Underfrequency Warning Level | SINT | +| TAG | Energy Config | cfg_V_UndervoltageInhibitTime | Undervoltage Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_UndervoltageTripDelay | Undervoltage Trip Delay | REAL | +| TAG | Energy Config | cfg_V_UndervoltageTripLevel | Undervoltage Trip Level | REAL | +| TAG | Energy Config | cfg_V_UndervoltageWarningLevel | Undervoltage Warning Level | REAL | +| TAG | Energy Config | cfg_V_VoltageImbalanceInhibitTime | Voltage Imbalance Inhibit Time | SINT | +| TAG | Energy Config | cfg_V_VoltageImbalanceTripDelay | Voltage Imbalance Trip Delay | REAL | +| TAG | Energy Config | cfg_V_VoltageImbalanceTripLevel | Voltage Imbalance Trip Level | SINT | +| TAG | Energy Config | cfg_V_VoltageImbalanceWarningLevel | Voltage Imalance Warning Level | SINT | +| TAG | Energy Config | cfg_V_VoltageMode | Voltage Mode ( ) | SINT | +| TAG | Energy Config | TripEnable_I_CurrentImbalance | Current Imbalance Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_GroundFault | Ground Fault Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Jam | Jam Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_LineLoss | Line Loss Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Overcurrent | Overcurrent Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Overload | Overload Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_PhaseLoss | Phase Loss Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Stall | Stall Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Undercurrent | Undercurrent Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_I_Underload | Underload Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_Overfrequency | Overfrequency Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_Overvoltage | Overvoltage Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_PhaseRotation | Phase Rotation Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_Underfrequency | Underfrequency Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_Undervoltage | Undervoltage Trip Enabled | BOOL | +| TAG | Energy Config | TripEnable_V_VoltageUnbalance | Voltage Imbalance Trip Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_CurrentImbalance | Current Imbalance Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_GroundFault | Ground Fault Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_Jam | Jam Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_LineLoss | Line Loss Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_Overcurrent | Overcurrent Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_Overload | Overload Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_Undercurrent | Undercurrent Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_I_Underload | Underload Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_Overfrequency | Overfrequency Wanring Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_Overvoltage | Overvoltage Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_PhaseRotation | Phase Rotation Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_Underfrequency | Underfrequency Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_Undervoltage | Undervoltage Warning Enabled | BOOL | +| TAG | Energy Config | WarningEnable_V_VoltageUnbalance | Voltage Imbalance Warning Enabled | BOOL | +| TAG | Energy Status | E300_AverageCurrent | Average Current | REAL | +| TAG | Energy Status | E300_AverageLLVoltage | Average Line-to-Line Voltage | REAL | +| TAG | Energy Status | E300_ControlTripBit | Control Trip Status Integer (-1 = No Trip) | DINT | +| TAG | Energy Status | E300_ControlTripStatus | Control Trip Status | STRING | +| TAG | Energy Status | E300_ControlWarningBit | Control Warning Status Integer (-1 = No Warning) | DINT | +| TAG | Energy Status | E300_ControlWarningStatus | Control Warning Status | STRING | +| TAG | Energy Status | E300_CurrentTripBit | Current Trip Status Integers (-1 = No Trip) | DINT | +| TAG | Energy Status | E300_CurrentTripStatus | Current Trip Status | STRING | +| TAG | Energy Status | E300_CurrentWarningBit | Current Warning Status Integer (-1= No Warning) | DINT | +| TAG | Energy Status | E300_CurrentWarningStatus | Current Warning Status | STRING | +| TAG | Energy Status | E300_L1Current | L1 Current | REAL | +| TAG | Energy Status | E300_L1L2Voltage | L1-L2 Voltage | REAL | +| TAG | Energy Status | E300_L2Current | L2 Current | REAL | +| TAG | Energy Status | E300_L2L3Voltage | L2-L3 Voltage | REAL | +| TAG | Energy Status | E300_L3Current | L3 Current | REAL | +| TAG | Energy Status | E300_L3L1Voltage | L3-L1 Voltage | REAL | +| TAG | Energy Status | E300_LineFrequency | Line Frequency | REAL | +| TAG | Energy Status | E300_PercentCurrentUnbalance | Percent Current Imbalance | REAL | +| TAG | Energy Status | E300_PercentVoltageUnbalance | Percent Voltage Imbalance | REAL | +| TAG | Energy Status | E300_PhaseRotation | Phase Rotation (String) | STRING | +| TAG | Energy Status | E300_PhaseRotation_INT | Phase Rotation Integer | DINT | +| TAG | Energy Status | E300_PowerTripBit | Power Trip Status Integer (-1 = No Trip) | DINT | +| TAG | Energy Status | E300_PowerTripStatus | Power Trip Status | STRING | +| TAG | Energy Status | E300_PowerWarningBit | Power Warning Status Integer (-1 = No Warning) | DINT | +| TAG | Energy Status | E300_PowerWarningStatus | Power Warning Status | STRING | +| TAG | Energy Status | E300_ThreePhaseTruePowerFactor | True 3-Phase Power Factor | REAL | +| TAG | Energy Status | E300_TotalApparentPower | Total Apparent Power (kVA) | REAL | +| TAG | Energy Status | E300_TotalReactivePower | Total Reactive Power (kVAR) | REAL | +| TAG | Energy Status | E300_TotalRealPower | Total Real Power (kW) | REAL | +| TAG | Energy Status | E300_VoltageTripBit | Voltage Trip Status Integer (-1 = No Trip) | DINT | +| TAG | Energy Status | E300_VoltageTripStatus | Voltage Trip Status | STRING | +| TAG | Energy Status | E300_VoltageWarningBit | Voltage Warning Status Integer (-1 = No Warning) | DINT | +| TAG | Energy Status | E300_VoltageWarningStatus | Voltage Warning Status | STRING | +| ALIAS | Energy Status | TripStatus | Trip Present | BOOL | +| TAG | Energy Status | VoltageOK | Voltage is within the tolerable Limits | BOOL | +| TAG | Flow | FlowRate | Scaled Flow Rate | REAL | +| ALIAS | Flow | Flowmeter_HART_Failure | Communication Failure between HART card and Flowmeter | BOOL | +| TAG | Flow | LASTMONTH_TOTAL_BBL | Last Month Total BBL | REAL | +| TAG | Flow | LASTMONTH_TOTAL_RUN_TIME_HOURS | Last Month Total Runtime Hours | REAL | +| TAG | Flow | THISMONTH_TOTAL_BBL | This Month Total BBL | REAL | +| TAG | Flow | THISMONTH_TOTAL_RUN_TIME_HOURS | This Month Total Runtime Hours | REAL | +| TAG | Flow | TODAY_TOTAL_BBL | Today's Total BBL | REAL | +| TAG | Flow | TODAY_TOTAL_RUN_TIME_HOURS | Today's Total Runtime Hours | REAL | +| TAG | Flow | YESTERDAY_TOTAL_BBL | Yesterday's Total BBL | REAL | +| TAG | Flow | YESTERDAY_TOTAL_RUN_TIME_HOURS | Testerday's Total Runtime Hours | REAL | +| TAG | Permissive | RP_Flow | Run not prevented by Flow | BOOL | +| TAG | Permissive | RP_Mode | Run not prevented by Mode | BOOL | +| TAG | Permissive | RP_Pressure | Run not prevented by Downhole Pressure | BOOL | +| TAG | Permissive | RP_Remote | Run not prevented by Remote Trip | BOOL | +| TAG | Permissive | RP_Temperature | Run not prevented by Downhole Temperature | BOOL | +| TAG | Permissive | RP_Trip | Run not prevented by Energy Trip | BOOL | +| TAG | Permissive | RP_TubingPressure | Run not prevented by Tubing Pressure | BOOL | +| TAG | Permissive | Run_Permissive | Run not prevented | BOOL | +| TAG | Permissive | SP_Mode | Startup not prevented by Mode | BOOL | +| TAG | Permissive | SP_Pressure | Startup not prevented by Downhole Pressure | BOOL | +| TAG | Permissive | SP_Remote | Startup not prevented by Remote Trip | BOOL | +| TAG | Permissive | SP_Temperature | Startup not prevented by Downhole Temperature | BOOL | +| TAG | Permissive | SP_Trip | Startup not prevented by Energy Trip | BOOL | +| TAG | Permissive | SP_Voltage | Startup not prevented by Voltage | BOOL | +| TAG | Permissive | Start_Permissive | Startup not prevented | BOOL | +| TAG | Watchdog | datalogger_watchdog | DataLogger Handshake: Datalogger will write 1 to this tag when it sees 0 | BOOL | +| TAG | Watchdog | Datalogger_Watchdog_Timeout | The datalogger is not communicating with the PLC | BOOL | diff --git a/docs/Wiring.md b/docs/Wiring.md new file mode 100644 index 0000000..453c8f6 --- /dev/null +++ b/docs/Wiring.md @@ -0,0 +1,43 @@ +# Wiring Guide + +## Digital Inputs + +| Input | Device | +|---------- | --------------------- | +| 0 | Legacy Contactor | +| 1 | Legacy HOA Auto | +| 2 | Legacy Start Button | +| 3 | High Pressure Switch | +| 4 | UPS Ready | +| 5 | UPS Buffering | +| 6 | UPS Replace Battery | +| 7 | Lightning Arrestor | + + +## Digital Outputs + +| Output | Device | +|---------- | --------------------- | +| 0 | Legacy Contactor | + +## Analog Inputs + +| Input | Device | +|---------- | --------------------- | +| 0 | Pressure Transmitter | +| 1 | Flowmeter | + +## E300 Inputs + +| Input | Device | +|---------- | --------------------- | +| 0 | Contactor | +| 1 | Start Button | +| 2 | Auto Mode Switch | +| 3 | Hand Mode Switch | + +## E300 Outputs + +| Output | Device | +|---------- | --------------------- | +| 0 | Contactor | diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..7a28c97 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,14 @@ +# PWM Intelligent Pump Panel + +Pump Panel for controlling Santa Rosa Water Wells. + +## Links + +- [Wiring Guide](Wiring.md) +- [Integer Mappings](Mapping.md) +- [SCADA Tags](SCADA.md) + + +## Contributors + +- [Patrick McDonagh](https://github.com/patrickjmcd)