Please refer to the Installation and Configuration documentation for installing the CSE and setting up the CSE's configuration.
You can start the CSE by simply running it from the command line:
python3 -m acme
In this case the configuration file acme.ini configuration file must be in the same directory. An interactive configuration process is started if the configuration file is not found.
In additions, you can provide additional command line arguments that will override the respective settings from the configuration file:
| Command Line Argument | Description |
|---|---|
| -h, --help | Show a help message and exit. |
| --config <filename> | Specify a configuration file that is used instead of the default (acme.ini) one. |
| --db-reset | Reset and clear the database when starting the CSE. |
| --db-storage {memory,disk} | Specify the DB's storage mode. This overrides the inMemory configuration setting. |
| --headless | Operate the CSE in headless mode. This disables almost all screen output and also the build-in console interface. |
| --http, --https | Run the CSE with http or https server. This overrides the useTLS configuration setting. |
| --http-wsgi | Run CSE with http WSGI support. This overrides the http.wsgi.enable configuration setting. |
| --http-address <server URL> | Specify the CSE's http server URL. This overrides the address configuration setting. |
| --http-port <http port> | Specify the CSE's http server port. This overrides the address configuration setting. |
| --import-directory <directory> | Specify the import directory. This overrides the resourcesPath configuration setting. |
| --network-interface <ip address | Specify the network interface/IP address to bind to. This overrides the listenIF configuration setting. |
| --log-level {info, error, warn, debug, off} | Set the log level, or turn logging off. This overrides the level configuration setting. |
| --mqtt, --no-mqtt | Enable or disable the MQTT binding. This overrides MQTT's enable configuration setting. |
| --remote-cse, --no-remote-cse | Enable or disable remote CSE connections and checking. This overrides the enableRemoteCSE configuration setting. |
| --statistics, --no-statistics | Enable or disable collecting CSE statistics. This overrides the enable configuration setting. |
| --textui | Run the CSE's text UI after startup. |
Please see Development - Debug Mode how to enable the debug mode to see further information in case you run into problems when trying to run the CSE.
The CSE can be stopped by pressing pressing the uppercase Q key or CTRL-C once on the command line. 1
Please note, that the shutdown might take a moment (e.g. gracefully terminating background processes, writing database caches, sending notifications etc).
Being impatient and hitting CTRL-C twice might lead to data corruption.
The CSE has a command console interface to execute build-in commands.
See Command Console for further details.
If you want to work with subscriptions and notification then you might want to have a Notifications Server running first before starting the CSE. The Notification Server provided with the CSE in the tools/notificationServer directory provides a very simple implementation that receives and answers notification requests.
See the Notification Server's README file for further details.
Footnotes
-
You can configure this behavior with the [cse.console].confirmQuit configuration setting. ↩