Skip to content

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
baudev committed Mar 21, 2020
1 parent d8c6507 commit 635b6d8
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,63 +37,63 @@ Returns an instance of `Camera`.

+ id - (_number_) The camera number to control.

**getConfigList(): Promise<string>**
**getConfigList(): Promise\<string>**

Lists all the configuration values for the camera.

**setConfig(parm, value1): Promise<void>**
**setConfig(parm, value1): Promise\<void>**

+ parm - (_string_) Name of the parameter
+ value1 - (_string_) New value of the specified parameter

Set the value for the requested parameter.

**getConfig(parm): Promise<string>**
**getConfig(parm): Promise\<string>**

+ parm - (_string_) The name of the parameter

Return the value currently set for the parameter.

**writeConfig(): Promise<string>**
**writeConfig(): Promise\<string>**

Write the current parameters to the file.

**getDetectionStatus(): Promise<MotionDetectionStatus>**
**getDetectionStatus(): Promise\<MotionDetectionStatus>**

Return the current status of the camera. `MotionDetectionStatus.ENABLE` is enable or `MotionDetectionStatus.DISABLE` if disabled.

**getConnectionStatus(): Promise<MotionConnectionStatus>**
**getConnectionStatus(): Promise\<MotionConnectionStatus>**

Return the connection status of the camera. `MotionConnectionStatus.OK` if well connected otherwise `MotionConnectionStatus.DISCONNECTED`.

**startDetection(): Promise<string>**
**startDetection(): Promise\<string>**

Start or resume motion detection.

**pauseDetection(): Promise<string>**
**pauseDetection(): Promise\<string>**

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<string>**
**startEvent(): Promise\<string>**

Trigger a new event.

**endEvent(): Promise<string>**
**endEvent(): Promise\<string>**

Trigger the end of a event.

**createSnapshot(): Promise<void>**
**createSnapshot(): Promise\<void>**

Create a snapshot

**restart(): Promise<string>**
**restart(): Promise\<string>**

Shutdown and restart Motion.

**quit(): Promise<string>**
**quit(): Promise\<string>**

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<string>**
**end(): Promise\<string>**

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._

0 comments on commit 635b6d8

Please sign in to comment.