Skip to content

Commit

Permalink
shared-state-async: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
javierajorge committed May 9, 2024
1 parent 2e744b8 commit 8c9a6fe
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions packages/shared-state-async/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,10 @@ VoCore2: Develop for OpenWrt on Qt Creator
https://vonger.cn/?p=14657

=== Plugin related notes
Plugins must be registered into shared state by using the config file. UCI infrastructure is preferred
Plugins must be registered into shared-state-async by using the config file. UCI infrastructure is preferred

[source,console]
--------------------------------------------------------------------------------
mSc="plugin_name"
uci set shared-state.${mSc}=dataType
Expand All @@ -58,9 +60,11 @@ uci set shared-state.${mSc}.scope='community'
uci set shared-state.${mSc}.ttl='1200'
uci set shared-state.${mSc}.update_interval='120'
uci commit shared-state
--------------------------------------------------------------------------------

Publishers must be located at "usr/share/shared-state/publishers"
Publishers must be located at +/usr/share/shared-state/publishers+
All Publishers will be called at least once using shared-state-async-publish-all

Sync is called automatically by shared state according to upgrade interval parameter

Sync is called automatically by shared-state-async according to "update_interval" parameter
"ttl" stands for "time to live" and will decrease until 0.
Data contents will be erased if "ttl" reaches 0.

0 comments on commit 8c9a6fe

Please sign in to comment.