Skip to content

Commit

Permalink
Update new Cam() text from @fbertone
Browse files Browse the repository at this point in the history
  • Loading branch information
RogerHardiman committed Nov 27, 2019
1 parent db8bfa8 commit bbdec56
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,9 @@ onvif.Discovery.probe(function(err, cams) {
});
```

In all of that cases you've got disconnected cameras because to manage them you need tuple `username:password`.
So, as shown in the examples, you can assign these properties and call `connect` method to get full functionality.
In all of that cases you've got disconnected cameras. To access each camera (and issue ONVIF commands) you normally need
the tuple `username:password`. So, as shown in the examples, you can assign these properties and call `connect` method to
get full functionality.

### Discovery.probe(options, callback)
Options
Expand All @@ -138,8 +139,10 @@ Options are:
- username, password (optional, to deal with majority of functions)
- port (optional)

If the username and password are present, camera tries to connect automatically. Otherwise use `connect` method.
Once again, without credentials you can execute only `getSystemDateAndTime` method.
The library calls connect() automatically which executes the `getSystemDateAndTime`, `getCapabilities` and other methods.
Note on username and password:
- Some cameras do not require username:password credentials.
- If a camera does require a username:password but you do not provide them, you will be limited to executing a few ONVIF methods that can operate without credentials, for example you can execute only `getSystemDateAndTime` method.

Callback (optional) executes when the cam is initialised. Single argument for this function is possible error.

Expand Down Expand Up @@ -185,7 +188,7 @@ without passing options object use it. You can change it manually at any time.
- ptz

### connect(callback)
Connect to the camera and fill device information properties with `getCapabilities`, `getVideoSources`, `getProfiles` methods
Connect to the camera and fill device information properties with `getSystemDateAndTime`, `getCapabilities`, `getVideoSources`, `getProfiles` methods

See more detailed information at http://www.onvif.org/ver10/media/wsdl/media.wsdl
After cam initialisation we can run several ONVIF commands.
Expand Down

0 comments on commit bbdec56

Please sign in to comment.