DEPRECTATED: Standard for Status Message Files

Note: File-based status reporting is deprecated, and was a prospect for a slightly different implementation model. This page is preserved as it's possible the JSON structure may become part of the message standard for the API

Having a standardized output format for the status files makes it easier to integrate other systems to use pyminder.

Pyminder expects to find these status files in directory status, a subdirectory of pyminder's starting working directory. Each program, service, or system that wants to deliver status messages should write to its own file.

The file itself is a JSON object defining the following attributes:

• name, a string that names the service or program that generated this report.
• timestamp, a unix timestamp for when the status message was generated,
• errorlevel, a string indicating one of three possible error levels:
  • "info", for routine messages
  • "minor", for small errors that didn't interrupt the service necessarily
  • "major", for critical errors that otherwise interrupted the service
• message, a string of arbitrary length displaying the actual error message or status update that will be put to the screen.

Example:

{
 "name": "Bitcoin Miner",
 "timestamp": 00000000000,
 "errorlevel": "major",
 "message": "It's not efficient to mine cryptocurrency on a raspberry pi!"
}