Add interlock query (#7)

BloomyControls · Oct 30, 2024 · b042467 · b042467
2 parents 71d2a39 + 7401e0e
commit b042467
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/include/bci/abs/CInterface.h b/include/bci/abs/CInterface.h
@@ -408,6 +408,19 @@ int AbsScpiClient_ClearErrors(AbsScpiClientHandle handle);
  */
 int AbsScpiClient_GetAlarms(AbsScpiClientHandle handle, uint32_t* alarms_out);
 
+/**
+ * @brief Query the system interlock state. When in interlock, the unit will be
+ * put into its PoR state and cannot be controlled until the interlock is
+ * lifted.
+ *
+ * @param[in] handle SCPI client
+ * @param[out] interlock_out pointer to the interlock state
+ *
+ * @return 0 on success or a negative error code.
+ */
+int AbsScpiClient_GetInterlockState(AbsScpiClientHandle handle,
+                                    bool* interlock_out);
+
 /**
  * @brief Assert the software interlock (a recoverable alarm).
  *

diff --git a/include/bci/abs/ScpiClient.h b/include/bci/abs/ScpiClient.h
@@ -206,6 +206,15 @@ class ScpiClient {
    */
   Result<std::uint32_t> GetAlarms() const;
 
+  /**
+   * @brief Get the system interlock state. When in interlock, the unit will be
+   * put into its PoR state and cannot be controlled until the interlock is
+   * lifted.
+   *
+   * @return Result containing the interlock state or an error code.
+   */
+  Result<bool> GetInterlockState() const;
+
   /**
    * @brief Assert the software interlock.
    *

diff --git a/src/CInterface.cpp b/src/CInterface.cpp
@@ -361,6 +361,11 @@ int AbsScpiClient_GetAlarms(AbsScpiClientHandle handle, uint32_t* alarms_out) {
   return WrapGet(&sc::GetAlarms, handle, alarms_out);
 }
 
+int AbsScpiClient_GetInterlockState(AbsScpiClientHandle handle,
+                                    bool* interlock_out) {
+  return WrapGet(&sc::GetInterlockState, handle, interlock_out);
+}
+
 int AbsScpiClient_AssertSoftwareInterlock(AbsScpiClientHandle handle) {
   return WrapSet(&sc::AssertSoftwareInterlock, handle);
 }

diff --git a/src/ScpiClient_System.cpp b/src/ScpiClient_System.cpp
@@ -87,6 +87,10 @@ Result<std::uint32_t> ScpiClient::GetAlarms() const {
       .and_then(scpi::ParseIntResponse<std::uint32_t>);
 }
 
+Result<bool> ScpiClient::GetInterlockState() const {
+  return SendAndRecv("SYST:INT?\r\n").and_then(scpi::ParseBoolResponse);
+}
+
 ErrorCode ScpiClient::AssertSoftwareInterlock() const {
   return Send("SYST:ALARM:RAISE\r\n");
 }