feat: introduce startProbingONVIFDevices method (#7)

Author: patrickmichalina

.node-version

@@ -1 +1 @@
-11.5.0
+11.6.0

.nvmrc

@@ -1 +1 @@
-11.5.0
+11.6.0

README.md

@@ -32,6 +32,7 @@
 </p>
 
 ## Installation
+This package is designed to be run in a Node environment.
 ```sh
 npm i onvif-probe-rx
 ```
@@ -40,10 +41,10 @@ npm i onvif-probe-rx
 For the best developer experience use Typescript.
 
 ```ts
-import { probeONVIFDevices } from 'onvif-probe-rx'
+import { startProbingONVIFDevices } from 'onvif-probe-rx'
 
-probeONVIFDevices()
-  .run({})
+// starts probing the network using the default configuration
+startProbingONVIFDevices()
   .subscribe(console.info)
 ```
 
@@ -58,4 +59,18 @@ probeONVIFDevices()
     PROBE_NETWORK_TIMEOUT_MS: 20000
   })
   .subscribe(console.log)
+```
+
+## Default Configuration
+```ts
+const DEFAULT_CONFIG: IProbeConfig = {
+  PORT: 3702,
+  MULTICAST_ADDRESS: '239.255.255.250',
+  PROBE_SAMPLE_TIME_MS: 2000,
+  PROBE_SAMPLE_START_DELAY_TIME_MS: 0,
+  PROBE_NETWORK_TIMEOUT_MS: 2000 * 1.5,
+  ONVIF_DEVICES: ['NetworkVideoTransmitter', 'Device', 'NetworkVideoDisplay'],
+  DOM_PARSER: new DOMParser(),
+  NOT_FOUND_STRING: 'unknown'
+}
 ```

src/config.ts

@@ -1,13 +1,48 @@
 import { DOMParser } from 'xmldom'
 
+/**
+ * Probe configuration
+ */
 export interface IProbeConfig {
+  /**
+   * Port number.
+   */
   readonly PORT: number
+
+  /**
+   * Multicast address.
+   */
   readonly MULTICAST_ADDRESS: string
+
+  /**
+   * How frequent, in milliseconds, the network is scanned for devices.
+   */
   readonly PROBE_SAMPLE_TIME_MS: number
+
+  /**
+   * Delay, in miliseconds, before the first scan is sent.
+   */
   readonly PROBE_SAMPLE_START_DELAY_TIME_MS: number
+
+  /**
+   * Time it takes to determine if a device is no longer present on the network.
+   * This is best to be at least 1.5x longer than PROBE_SAMPLE_TIME_MS
+   */
   readonly PROBE_NETWORK_TIMEOUT_MS: number
+
+  /**
+   * ONVIF device types to check for.
+   */
   readonly ONVIF_DEVICES: ReadonlyArray<string>
+
+  /**
+   * An object the conforms to the W3C DOMParser spec. This helps parse respnse XML.
+   */
   readonly DOM_PARSER: DOMParser
+  
+  /**
+   * When an attribute is undefined, use this text instead.
+   */
   readonly NOT_FOUND_STRING: string
 }
 

src/index.ts

@@ -68,3 +68,5 @@ export const probeONVIFDevices = () => reader<Partial<IProbeConfig>, Observable<
       }, [])
     )
 })
+
+export const startProbingONVIFDevices = () => probeONVIFDevices().run({})