From 6add3c5dafc1bdd762345fc07fe64f69f3b58eb3 Mon Sep 17 00:00:00 2001
From: joshemb <josh@elixxir.io>
Date: Tue, 2 May 2023 10:56:41 -0700
Subject: [PATCH] Modify documentation of SetTrackNetworkPeriod for clarity on
Low Power Mode
---
wasm/follow.go | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/wasm/follow.go b/wasm/follow.go
index 7f573609..5c736b5a 100644
--- a/wasm/follow.go
+++ b/wasm/follow.go
@@ -87,6 +87,13 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any {
// SetTrackNetworkPeriod allows changing the frequency that follower threads
// are started.
//
+// Note that the frequency of the follower threads affect the power usage
+// of the device following the network.
+// - Low period -> Higher frequency of polling -> Higher battery usage
+// - High period -> Lower frequency of polling -> Lower battery usage
+// This may be used to enable a low power (or battery optimization) mode
+// for the end user.
+//
// Parameters:
// - args[0] - The duration of the period, in milliseconds (int).
func (c *Cmix) SetTrackNetworkPeriod(_ js.Value, args []js.Value) any {
--
GitLab