Make periodic reads protobuf streams to reuse open websockets

backend-rs/Cargo.lock

@@ -247,7 +247,7 @@ checksum = "0206175f82b8d6bf6652ff7d71a1e27fd2e4efde587fd368662814d6ec1d9ce0"
 
 [[package]]
 name = "fantastic-rs"
-version = "0.5.0-alpha2"
+version = "0.5.0-alpha3"
 dependencies = [
  "log",
  "nrpc",

backend-rs/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fantastic-rs"
-version = "0.5.0-alpha2"
+version = "0.5.0-alpha3"
 edition = "2021"
 authors = ["NGnius (Graham) <ngniusness@gmail.com>"]
 description = "Backend (superuser) functionality for Fantastic"
@@ -17,7 +17,7 @@ serde_json = "1.0"
 
 nrpc = { version = "0.10", path = "../../nRPC/nrpc" }
 prost = "0.11"
-tokio = { version = "1", features = ["sync"] }
+tokio = { version = "1", features = ["sync", "rt"] }
 
 sysfuss = { version = "0.3", features = ["derive"], path = "../../sysfs-nav" }
 

backend-rs/protos/fantastic.proto

@@ -20,10 +20,10 @@ service Fan {
   rpc name (Empty) returns (NameMessage);
 
   // Get fan speed
-  rpc get_fan_rpm (Empty) returns (RpmMessage);
+  rpc get_fan_rpm (Empty) returns (stream RpmMessage);
 
   // Get system temperature
-  rpc get_temperature (Empty) returns (TemperatureMessage);
+  rpc get_temperature (Empty) returns (stream TemperatureMessage);
 
   // Set custom fan control enabled
   rpc set_enable (EnablementMessage) returns (EnablementMessage);

backend-rs/src/api.rs

@@ -1,10 +1,15 @@
 use crate::services::fantastic::*;
 
+use usdpl_back::nrpc::_helpers::futures::{StreamExt, FutureExt};
+
 use super::control::ControlRuntime;
 
 pub const VERSION: &'static str = env!("CARGO_PKG_VERSION");
 pub const NAME: &'static str = env!("CARGO_PKG_NAME");
 
+const FAN_READ_PERIOD: std::time::Duration = std::time::Duration::from_millis(1000);
+const TEMPERATURE_READ_PERIOD: std::time::Duration = std::time::Duration::from_millis(2000);
+
 pub struct FanService {
     ctrl: ControlRuntime,
 }
@@ -18,6 +23,11 @@ impl FanService {
     }
 }
 
+fn once_true() -> impl std::iter::Iterator<Item = bool> {
+    // iters over [true, false, false, ...]
+    std::iter::once(true).chain(std::iter::repeat(false))
+}
+
 #[usdpl_back::nrpc::_helpers::async_trait::async_trait]
 impl<'a> IFan<'a> for FanService {
     async fn echo(
@@ -67,29 +77,57 @@ impl<'a> IFan<'a> for FanService {
                 }
             )
         }
-        async fn get_fan_rpm(
+        async fn get_fan_rpm<'b: 'a>(
             &mut self,
             _input: Empty,
-        ) -> Result<RpmMessage, Box<dyn std::error::Error + Send>> {
+        ) -> Result<
-            if let Some(rpm) = crate::sys::read_fan(self.ctrl.hwmon()) {
+            usdpl_back::nrpc::ServiceServerStream<'b, RpmMessage>,
-                log::debug!("get_fan_rpm() success: {}", rpm);
+            Box<dyn std::error::Error + Send>,
-                Ok(RpmMessage { rpm: rpm as u32 })
+        > {
-            } else {
+            let hwmon = self.ctrl.hwmon_clone();
-                Err(Box::<dyn std::error::Error + Send + Sync>::from("Failed to read fan speed"))
+            let stream = usdpl_back::nrpc::_helpers::futures::stream::iter(once_true()).then(move |is_first| {
-            }
+                let hwmon = hwmon.clone();
+                tokio::task::spawn_blocking(
+                    /* tokio::time::sleep(..) is not Unpin (but this is)... *grumble grumble* */
+                    move || if !is_first { std::thread::sleep(FAN_READ_PERIOD); })
+                .map(move |_| {
+                        if let Some(rpm) = crate::sys::read_fan(&hwmon) {
+                            log::debug!("get_fan_rpm() success: {}", rpm);
+                            Ok(RpmMessage { rpm: rpm as u32 })
+                        } else {
+                            Err(usdpl_back::nrpc::ServiceError::Method(Box::<dyn std::error::Error + Send + Sync>::from("Failed to read fan speed")))
+                        }
+                    })
+            });
+            Ok(Box::new(stream))
         }
-        async fn get_temperature(
+
+        async fn get_temperature<'b: 'a>(
             &mut self,
             _input: Empty,
-        ) -> Result<TemperatureMessage, Box<dyn std::error::Error + Send>>{
+        ) -> Result<
-            if let Some(temperature) = crate::sys::read_thermal_zone(self.ctrl.thermal_zone()) {
+            usdpl_back::nrpc::ServiceServerStream<'b, TemperatureMessage>,
-                let real_temp = temperature as f64 / 1000.0;
+            Box<dyn std::error::Error + Send>,
-                log::debug!("get_temperature() success: {}", real_temp);
+        > {
-                Ok(TemperatureMessage { temperature: real_temp })
+            let thermal_zone = self.ctrl.thermal_zone_clone();
-            } else {
+            let stream = usdpl_back::nrpc::_helpers::futures::stream::iter(once_true()).then(move |is_first| {
-                Err(Box::<dyn std::error::Error + Send + Sync>::from("get_temperature failed to read thermal zone 0"))
+                let thermal_zone = thermal_zone.clone();
-            }
+                tokio::task::spawn_blocking(
+                    /* tokio::time::sleep(..) is not Unpin (but this is)... *grumble grumble* */
+                    move || if !is_first { std::thread::sleep(TEMPERATURE_READ_PERIOD); })
+                .map(move |_| {
+                        if let Some(temperature) = crate::sys::read_thermal_zone(&thermal_zone) {
+                            let real_temp = temperature as f64 / 1000.0;
+                            log::debug!("get_temperature() success: {}", real_temp);
+                            Ok(TemperatureMessage { temperature: real_temp })
+                        } else {
+                            Err(usdpl_back::nrpc::ServiceError::Method(Box::<dyn std::error::Error + Send + Sync>::from("get_temperature failed to read thermal zone 0")))
+                        }
+                    })
+            });
+            Ok(Box::new(stream))
         }
+
         async fn set_enable(
             &mut self,
             input: EnablementMessage,

backend-rs/src/control.rs

@@ -49,12 +49,20 @@ impl ControlRuntime {
         &self.state
     }
 
-    pub(crate) fn hwmon(&self) -> &'_ HwMonPath {
+    /*pub(crate) fn hwmon(&self) -> &'_ HwMonPath {
         &self.hwmon
+    }*/
+
+    pub(crate) fn hwmon_clone(&self) -> Arc<HwMonPath> {
+        self.hwmon.clone()
     }
 
-    pub(crate) fn thermal_zone(&self) -> &'_ BasicEntityPath {
+    /*pub(crate) fn thermal_zone(&self) -> &'_ BasicEntityPath {
         &self.thermal_zone
+    }*/
+
+    pub(crate) fn thermal_zone_clone(&self) -> Arc<BasicEntityPath> {
+        self.thermal_zone.clone()
     }
 
     pub fn run(&self) -> thread::JoinHandle<()> {

backend-rs/src/sys.rs

@@ -5,23 +5,34 @@ const HWMON_INDEX: u64 = 5;
 
 pub const RECALCULATE_ATTR: HwMonAttribute = HwMonAttribute::custom("recalculate");
 pub const FAN1_INPUT_ATTR: HwMonAttribute = HwMonAttribute::new(HwMonAttributeType::Fan, 1, HwMonAttributeItem::Input);
+pub const FAN1_LABEL_ATTR: HwMonAttribute = HwMonAttribute::new(HwMonAttributeType::Fan, 1, HwMonAttributeItem::Label);
 pub const FAN1_TARGET_ATTR: HwMonAttribute = HwMonAttribute::custom("fan1_target");
 
 const HWMON_NEEDS: [HwMonAttribute; 3] = [
-    RECALCULATE_ATTR,
+    //RECALCULATE_ATTR,
     FAN1_INPUT_ATTR,
     FAN1_TARGET_ATTR,
+    FAN1_LABEL_ATTR,
 ];
 
 pub fn read_fan(hwmon: &HwMonPath) -> Option<u64> {
-    hwmon.attribute(FAN1_INPUT_ATTR).ok()
+    match hwmon.attribute(FAN1_INPUT_ATTR){
-    //read_single(format!("/sys/class/hwmon/hwmon{}/fan1_input", HWMON_INDEX)).ok()
+        Ok(x) => Some(x),
+        Err(e) => {
+            log::error!("Failed read_fan(): {}", e);
+            None
+        },
+    }
 }
 
-// TODO convert to sysfuss
 pub fn read_thermal_zone(entity: &BasicEntityPath) -> Option<u64> {
-    entity.attribute("temp".to_owned()).ok()
+    match entity.attribute("temp".to_owned()) {
-    //read_single(format!("/sys/class/thermal/thermal_zone{}/temp", index)).ok()
+        Ok(x) => Some(x),
+        Err(e) => {
+            log::error!("Failed read_thermal_zone(): {}", e);
+            None
+        },
+    }
 }
 
 pub fn write_fan_recalc(hwmon: &HwMonPath, enabled: bool) -> Result<(), std::io::Error> {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Fantastic",
-  "version": "0.5.0-alpha1",
+  "version": "0.5.0-alpha3",
   "description": "A template to quickly create decky plugins from scratch, based on TypeScript and webpack",
   "scripts": {
     "build": "shx rm -rf dist && rollup -c",

src/backend.ts

@@ -94,12 +94,10 @@ export async function removeCurvePoint(index: number): Promise<{"x": number, "y"
     //return (await call_backend("remove_curve_point", [index]))[0];
 }
 
-export async function getFanRpm(): Promise<number> {
+export async function getFanRpm(callback: (rpm: number) => void): Promise<void> {
-    return (await FAN_CLIENT!.get_fan_rpm(true))?? 1337;
+    return (await FAN_CLIENT!.get_fan_rpm(true, callback));
-    //return (await call_backend("get_fan_rpm", []))[0];
 }
 
-export async function getTemperature(): Promise<number> {
+export async function getTemperature(callback: (temp: number) => void): Promise<void> {
-    return (await FAN_CLIENT!.get_temperature(true))?? -273;
+    return (await FAN_CLIENT!.get_temperature(true, callback));
-    //return (await call_backend("get_temperature", []))[0];
 }

src/index.tsx

@@ -27,6 +27,12 @@ var version: string = "";
 
 var curve_backup: {x: number, y: number}[] = [];
 
+var tempCache: number = -1337;
+var setTemperature_display = (_: number) => {};
+
+var fanRpmCache: number = -273;
+var setFanRpm_display = (_: number) => {};
+
 const Content: VFC<{ serverAPI: ServerAPI }> = ({serverAPI}) => {
   // const [result, setResult] = useState<number | undefined>();
 
@@ -54,8 +60,16 @@ const Content: VFC<{ serverAPI: ServerAPI }> = ({serverAPI}) => {
     curve_backup = value;
   }
 
-  const [temperatureGlobal, setTemperature] = useState<number>(-273.15);
+  const [temperatureGlobal, setTemperature] = useState<number>(tempCache);
-  const [fanRpmGlobal, setFanRpm] = useState<number>(-1337);
+  const [fanRpmGlobal, setFanRpm] = useState<number>(fanRpmCache);
+  setTemperature_display = (x) => {
+    setTemperature(x);
+    tempCache = x;
+  };
+  setFanRpm_display = (x) => {
+    setFanRpm(x);
+    fanRpmCache = x;
+  };
 
   function setEnable(enable: boolean) {
     setEnableInternal(enable);
@@ -206,17 +220,17 @@ const Content: VFC<{ serverAPI: ServerAPI }> = ({serverAPI}) => {
     backend.resolve(backend.getEnabled(), setEnable);
     backend.resolve(backend.getInterpolate(), setInterpol);
     backend.resolve(backend.getCurve(), setCurve);
-    backend.resolve(backend.getTemperature(), setTemperature);
+    backend.resolve(backend.getTemperature(setTemperature_display), (_: any) => {});
-    backend.resolve(backend.getFanRpm(), setFanRpm);
+    backend.resolve(backend.getFanRpm(setFanRpm_display), (_: any) => {});
 
     if (periodicHook != null) {
       clearInterval(periodicHook);
     }
 
-    periodicHook = setInterval(function() {
+    /*periodicHook = setInterval(function() {
         backend.resolve(backend.getTemperature(), setTemperature);
         backend.resolve(backend.getFanRpm(), setFanRpm);
-    }, 1000);
+    }, 1000);*/
   }
 
   if (!usdplReady) {