From 635b6d8b1f064cb5dfb0c1f06398a46ce473cd4d Mon Sep 17 00:00:00 2001 From: baudev Date: Sat, 21 Mar 2020 23:09:08 +0100 Subject: [PATCH] Updates README --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 862a852..9aa3e37 100644 --- a/README.md +++ b/README.md @@ -37,63 +37,63 @@ Returns an instance of `Camera`. + id - (_number_) The camera number to control. -**getConfigList(): Promise** +**getConfigList(): Promise\** Lists all the configuration values for the camera. -**setConfig(parm, value1): Promise** +**setConfig(parm, value1): Promise\** + parm - (_string_) Name of the parameter + value1 - (_string_) New value of the specified parameter Set the value for the requested parameter. -**getConfig(parm): Promise** +**getConfig(parm): Promise\** + parm - (_string_) The name of the parameter Return the value currently set for the parameter. -**writeConfig(): Promise** +**writeConfig(): Promise\** Write the current parameters to the file. -**getDetectionStatus(): Promise** +**getDetectionStatus(): Promise\** Return the current status of the camera. `MotionDetectionStatus.ENABLE` is enable or `MotionDetectionStatus.DISABLE` if disabled. -**getConnectionStatus(): Promise** +**getConnectionStatus(): Promise\** Return the connection status of the camera. `MotionConnectionStatus.OK` if well connected otherwise `MotionConnectionStatus.DISCONNECTED`. -**startDetection(): Promise** +**startDetection(): Promise\** Start or resume motion detection. -**pauseDetection(): Promise** +**pauseDetection(): Promise\** Pause the motion detection. _When the action of pause is executed, Motion will stop the motion detection processing and of course all events but will continue to process and decode images from the camera. This allows for a faster transition when the user executes a start._ -**startEvent(): Promise** +**startEvent(): Promise\** Trigger a new event. -**endEvent(): Promise** +**endEvent(): Promise\** Trigger the end of a event. -**createSnapshot(): Promise** +**createSnapshot(): Promise\** Create a snapshot -**restart(): Promise** +**restart(): Promise\** Shutdown and restart Motion. -**quit(): Promise** +**quit(): Promise\** Close all connections to the camera. _The quit action conversely not only stops the motion detection but also disconnects from the camera and decoding of images. To start motion detection after a quit, the user must execute a restart which will reinitialize the connection to the camera. And since the camera was completely disconnect, it can take more than a few seconds for Motion to fully start and have the camera available for processing or viewing._ -**end(): Promise** +**end(): Promise\** Entirely shutdown the Motion application. _This option completely terminates the Motion application. It closes all connections to all the cameras and terminates the application. This may be required when running Motion in daemon mode. Note that there is no way to restart the Motion application from the webcontrol interface after processing a end request._ \ No newline at end of file