Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ricardo committed Jun 27, 2015
1 parent 12a3c00 commit 93f28de
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,70 @@ var myCamera = new Foscam({
});

```

### ptzMoveUp ( [time] )

In order to connect to the camera you first need to provide its access details. This will create an object for that particular camera. You can create as much objects as you need, so you can control multiple cameras.

name | type | default | description
-----|--------|---------------|----------------------
time | int | | Value in miliseconds before stop


```js

//The camera will move Up for 2 seconds
myCamera.ptzMoveUp(2000);

```

### ptzMoveDown ( [time] )
### ptzMoveRight ( [time] )
### ptzMoveLeft ( [time] )
### ptzMoveTopLeft ( [time] )
### ptzMoveTopRight ( [time] )
### ptzMoveBottomLeft ( [time] )
### ptzMoveBottomRight ( [time] )
### ptzStopRun ( )
### ptzReset ( )

### getPTZSpeed ( )

Returns the current of pan/tilt speed of the camera. They are 5 possible values

- 0 -> Very Slow
- 1 -> Slow
- 2 -> Normal
- 3 -> Fast
- 4 -> Very Fast

```js

//The camera will move Up for 2 seconds
myCamera
.getPTZSpeed()
.then(function(speed) {
//DO WHAT YOU NEED WITH THE SPEED
});

```

### setPTZSpeed ( speed )

This method allow you to set the speed of the camera. Valid values comes from 0 to 4, being 0 the slowest and 4 the fastest speed.

name | type | default | description
------|--------|---------------|----------------------
speed | int | | Speed you want for the camera


```js

//The camera will move Up for 2 seconds
myCamera
.setPTZSpeed(2)
.then(function() {
//NOW THE SPEED IS NORMAL
});

```

0 comments on commit 93f28de

Please sign in to comment.