StateStore

Scarlet has a simple way of storing basic data between program runs, called the StateStore. Some Scarlet components rely on the StateStore to work, for example BBBPinManager to keep track of device tree versions.

Preparation: To begin using the StateStore, you'll want to initialize it near the beginning of execution of your program by doing this:
StateStore.Start("YourClientApplicationName"); (e.g. "SciRover")

Usage: Now, the following methods are available to you:

• void StateStore.Save();
  • This simply saves all of the currently stored settings into the file. Do this after changing important data, or when your program is exiting (changes are not auto-saved).
• void StateStore.Set(string Key, string Value);
  • Creates a key if it doesn't yet exist. Sets it to the given value.
• string StateStore.Get(string Key);
  • Gets a value, or null if the key does not exist.
• string StateStore.GetOrCreate(string Key, string DefaultValue);
  • If the key exists, returns its value. If it doesn't, creates it, sets it to DefaultValue, then returns that.
• bool StateStore.Started;
  • Whether or not StateStore.Start() has been called and StateStore is ready for use.