Getting Started With MudPi

To get started, install MudPi using the installation docs and edit your configuration file.

Using your terminal of choice enter the command mudpi to run MudPi.

If you want to tell MudPi where to find your config file use the --config flag or the shorthand -c. To tell MudPi to look for a config file other than the default one you will need to use this flag. If you do not specify an absolute path this will be treated relative to the current directory you are running the command from.

mudpi --config /home/mudpi/core/mudpi/mudpi.config

If you installed MudPi using the installer then MudPi will already be trying to run in the background and just needs a configuration file.

Example Configuration

You should read more on the configuration docs to get familiar with the basics of configurations in MudPi.

Here is a basic configuration using example components which are useful for testing. This file can be saved as mudpi.config in the /home/mudpi/core/mudpi folder if you used the standard installation.

{
    "mudpi": {
        "name": "MudPi Example",
        "debug": false
    },
    "sensor":[{
        "key": "example_sensor_1",
        "interface": "example"
    }]
}

The MudPi User

If you use the recommended MudPi installer then a mudpi user is created for you. This is the user account the MudPi should be run from. If you run MudPi from any other account be sure that it has proper permissions and access. If you used the installer then you are recommended to use this MudPi user.

Monitor MudPi Running in the Background

If you run MudPi manually then you can get the output in your terminal. However if MudPi is running in the background (which is the recommended way) you may want to also check the output in your terminal still. You can open the log files located in the /home/mudpi/logs folder. There are output.log and error.log files you can open with your editor of choice.

Another way to check the log for realtime updates is using the tail command with the follow flag.

tail -f logs/outout.log

You are now ready to add some real hardware to MudPi in the next step.