Update description on helicorder

anyshake · Oct 13, 2024 · 62039b6 · 62039b6
1 parent 6743ca6
commit 62039b6
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 13 deletions.
diff --git a/docs/AnyShake Observer/Configuration/Services/archiver.md b/docs/AnyShake Observer/Configuration/Services/archiver.md
@@ -4,7 +4,7 @@ sidebar_position: 2
 
 # Archiver Settings
 
- - Key: `archiver_settings`
+ - Key: `archiver`
  - Description: Archiver settings for AnyShake Observer
 
 This object configures settings for the optional archiver service. The archiver stores ADC readout to database by timestamp.
@@ -26,7 +26,7 @@ This object configures settings for the optional archiver service. The archiver
 ```json
 {
     "services_settings": {
-        "archiver_settings": {
+        "archiver": {
             "enable": true,
             "lifecycle": 10
         }

diff --git a/docs/AnyShake Observer/Configuration/Services/forwarder.md b/docs/AnyShake Observer/Configuration/Services/forwarder.md
@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # Forwarder Settings
 
- - Key: `forwarder_settings`
+ - Key: `forwarder`
  - Description: Forwarder settings for AnyShake Observer
 
 The AnyShake Observer provides a forwarder service that binds to a specific host and port to forward data to other services.
@@ -31,7 +31,7 @@ The AnyShake Observer provides a forwarder service that binds to a specific host
 ```json
 {
     "services_settings": {
-        "forwarder_settings": {
+        "forwarder": {
             "enable": true,
             "host": "0.0.0.0",
             "port": 30000

diff --git a/docs/AnyShake Observer/Configuration/Services/helicorder.md b/docs/AnyShake Observer/Configuration/Services/helicorder.md
@@ -0,0 +1,41 @@
+---
+sidebar_position: 5
+---
+
+# Helicorder Settings
+
+ - Key: `helicorder`
+ - Description: Helicorder settings for AnyShake Observer
+
+This object manages helicorder settings for AnyShake Observer, which are optional for its core functionality. When enabled, AnyShake Observer will generate daily helicorder images accessible through the web interface.
+
+## Fields
+
+### enable
+
+ - Type: `bool`
+ - Description: Enable helicorder output
+
+### lifecycle
+
+ - Type: `int`
+ - Description: helicorder file lifecycle, in days. Set to 0 to disable
+
+### path
+
+ - Type: `string`
+ - Description: Path to store helicorder files
+
+## Example
+
+```json
+{
+    "services_settings": {
+        "helicorder": {
+            "enable": false,
+            "lifecycle": 10,
+            "path": "/data/helicorder"
+        }
+    }
+}
+```
diff --git a/docs/AnyShake Observer/Configuration/Services/miniseed.md b/docs/AnyShake Observer/Configuration/Services/miniseed.md
@@ -4,34 +4,34 @@ sidebar_position: 1
 
 # MiniSEED Settings
 
- - Key: `miniseed_settings`
- - Description: MiniSEED settings for AnyShake Observer
+ - Key: `miniseed`
+ - Description: miniSEED settings for AnyShake Observer
 
-This object manages MiniSEED settings for AnyShake Observer, which are optional for its core functionality. When enabled, AnyShake Observer will generate daily MiniSEED files accessible through the web interface.
+This object manages miniSEED settings for AnyShake Observer, which are optional for its core functionality. When enabled, AnyShake Observer will generate daily miniSEED files accessible through the web interface.
 
 ## Fields
 
 ### enable
 
  - Type: `bool`
- - Description: Enable MiniSEED output
+ - Description: Enable miniSEED output
 
 ### lifecycle
 
  - Type: `int`
- - Description: MiniSEED file lifecycle, in days. Set to 0 to disable
+ - Description: miniSEED file lifecycle, in days. Set to 0 to disable
 
 ### path
 
  - Type: `string`
- - Description: Path to store MiniSEED files
+ - Description: Path to store miniSEED files
 
 ## Example
 
 ```json
 {
     "services_settings": {
-        "miniseed_settings": {
+        "miniseed": {
             "enable": false,
             "lifecycle": 10,
             "path": "/data/miniseed"

diff --git a/docs/AnyShake Observer/Configuration/Services/seedlink.md b/docs/AnyShake Observer/Configuration/Services/seedlink.md
@@ -4,7 +4,7 @@ sidebar_position: 4
 
 # SeedLink Settings
 
- - Key: `seedlink_settings`
+ - Key: `seedlink`
  - Description: SeedLink settings for AnyShake Observer
 
 This object manages SeedLink settings for AnyShake Observer, which are optional for its core functionality. When enabled, AnyShake Observer will start a SeedLink streamer so that users can access the live seismic data through SeedLink protocol.
@@ -38,7 +38,7 @@ This object manages SeedLink settings for AnyShake Observer, which are optional
 ```json
 {
     "services_settings": {
-        "seedlink_settings": {
+        "seedlink": {
             "enable": false,
             "host": "0.0.0.0",
             "port": 18000,

diff --git a/docs/AnyShake Observer/quick-start.md b/docs/AnyShake Observer/quick-start.md
@@ -97,6 +97,11 @@ Note that AnyShake has two hardware implementations, based on ESP8266 and STM32F
             "enable": true,
             "host": "0.0.0.0",
             "port": 18000
+        },
+        "helicorder": {
+            "enable": true,
+            "lifecycle": 10,
+            "path": "/home/user/helicorder"
         }
     }
 }