feat: discover wifi devices via ip scanning (#15)

Author: patrickmichalina

README.md

@@ -56,6 +56,45 @@ startProbingONVIFDevices()
   .subscribe(console.info)
 ```
 
+```js
+// example probe results
+// two cameras discovered on the network with ONVIF WS-Discovery via UDP
+// This will be the last emitted value in the observable until a new camera comes online
+// or a camera is disconnected or otherwise fails to respond to a ping.
+
+[ { name: 'Amcrest',
+    hardware: 'IP2M-8200',
+    location: 'china',
+    deviceServiceUri: 'http://192.168.5.191/onvif/device_service',
+    ip: '192.168.5.191',
+    metadataVersion: '1',
+    urn: 'fae40e7f-91e2-489a-afe6-66e19b667952',
+    scopes:
+     [ 'onvif://www.onvif.org/location/country/china',
+       'onvif://www.onvif.org/name/Amcrest',
+       'onvif://www.onvif.org/hardware/IP2M-8200',
+       'onvif://www.onvif.org/Profile/Streaming',
+       'onvif://www.onvif.org/type/Network_Video_Transmitter',
+       'onvif://www.onvif.org/extension/unique_identifier',
+       'onvif://www.onvif.org/Profile/G' ],
+    profiles: [ 'Streaming', 'G' ],
+    xaddrs: [ 'http://192.168.5.191/onvif/device_service' ] },
+  { name: 'IPCAM',
+    hardware: '421FZ',
+    location: 'china',
+    deviceServiceUri: 'http://192.168.5.13:80/onvif/device_service',
+    ip: '192.168.5.13',
+    metadataVersion: '1',
+    urn: '0cbc0d5b-a7a1-47c7-bb60-85c878bb540e',
+    scopes:
+     [ 'onvif://www.onvif.org/Profile/Streaming',
+       'onvif://www.onvif.org/Model/421FZ',
+       'onvif://www.onvif.org/Name/IPCAM',
+       'onvif://www.onvif.org/location/country/china' ],
+    profiles: [ 'Streaming' ],
+    xaddrs: [ 'http://192.168.5.13:80/onvif/device_service' ] } ]
+```
+
 If you'd like to tweak default settings feel free to override in the `.run()` method.
 
 ```ts
@@ -73,6 +112,7 @@ probeONVIFDevices()
 ```ts
 const DEFAULT_CONFIG: IProbeConfig = {
   PORT: 3702,
+  ENABLE_IP_SCANNING: true,
   MULTICAST_ADDRESS: '239.255.255.250',
   PROBE_SAMPLE_TIME_MS: 2000,
   PROBE_SAMPLE_START_DELAY_TIME_MS: 0,

src/config.ts

@@ -9,6 +9,11 @@ export interface IProbeConfig {
    */
   readonly PORT: number
 
+  /**
+   * Enabled IP based scanning
+   */
+  readonly ENABLE_IP_SCANNING: boolean
+
   /**
    * Multicast address.
    */
@@ -48,6 +53,7 @@ export interface IProbeConfig {
 
 export const DEFAULT_CONFIG: IProbeConfig = {
   PORT: 3702,
+  ENABLE_IP_SCANNING: true,
   MULTICAST_ADDRESS: '239.255.255.250',
   PROBE_SAMPLE_TIME_MS: 2000,
   PROBE_SAMPLE_START_DELAY_TIME_MS: 0,

src/index.ts

@@ -1,14 +1,15 @@
-import { map, distinctUntilChanged, takeUntil, mergeScan } from 'rxjs/operators'
-import { maybe, reader, IMaybe } from 'typescript-monads'
+import { map, distinctUntilChanged, takeUntil, mergeScan, flatMap } from 'rxjs/operators'
+import { timer, Observable, forkJoin, combineLatest } from 'rxjs'
 import { IProbeConfig, DEFAULT_CONFIG } from './config'
-import { timer, Observable, forkJoin } from 'rxjs'
-import { parseXmlResponse } from './parse'
+import { maybe, reader, IMaybe } from 'typescript-monads'
+import { parseXmlResponse, maybeIpAddress } from './parse'
 import { socketStream } from './socket-stream'
 import { probePayload } from './probe-payload'
 import { IONVIFDevice } from './device'
 export { IProbeConfig } from './config'
 import { MD5 } from 'object-hash'
 import { ping } from 'ping-rx'
+import { ipscan } from './ipscan'
 export { IONVIFDevice }
 export { DEFAULT_CONFIG }
 
@@ -42,7 +43,7 @@ export const probeONVIFDevices = () => reader<Partial<IProbeConfig>, ProbeStream
       buffers.forEach(b => ss.socket.send(b, 0, b.length, config.PORT, config.MULTICAST_ADDRESS))
     })
 
-  return socketMessages
+  const onvifScan = socketMessages
     .pipe(
       map(xmlResponse => xmlResponse
         .map(xmlString => config.DOM_PARSER.parseFromString(xmlString, 'application/xml'))
@@ -59,6 +60,29 @@ export const probeONVIFDevices = () => reader<Partial<IProbeConfig>, ProbeStream
             ])))
       }, []),
       distinctUntilChanged((a, b) => MD5(a) === MD5(b)))
+
+  const ipScan = () => timer(config.PROBE_SAMPLE_START_DELAY_TIME_MS, config.PROBE_SAMPLE_TIME_MS).pipe(flatMap(() => ipscan()))
+
+  return !config.ENABLE_IP_SCANNING
+    ? onvifScan
+    : combineLatest(onvifScan, ipScan(), (onvifResults, ipscanResults) => {
+      const ipDevicesNotInOnvifScan = ipscanResults.filter(a => !onvifResults.some(onv => onv.ip === maybeIpAddress(a).valueOrUndefined()))
+        .map<IONVIFDevice>(deviceServiceUri => {
+          return {
+            deviceServiceUri,
+            name: maybeIpAddress(deviceServiceUri).valueOr(config.NOT_FOUND_STRING),
+            hardware: config.NOT_FOUND_STRING,
+            location: config.NOT_FOUND_STRING,
+            ip: config.NOT_FOUND_STRING,
+            metadataVersion: config.NOT_FOUND_STRING,
+            urn: config.NOT_FOUND_STRING,
+            scopes: [],
+            profiles: [],
+            xaddrs: []
+          }
+        })
+      return [...onvifResults, ...ipDevicesNotInOnvifScan]
+    }).pipe(distinctUntilChanged((a, b) => MD5(a) === MD5(b)))
 })
 
 export const startProbingONVIFDevices = () => probeONVIFDevices().run({})
@@ -69,4 +93,7 @@ export const startProbingONVIFDevicesCli = () => startProbingONVIFDevices()
     console.log('Watching for connected ONVIF devices...', '\n')
     console.log(v)
   })
-  
+
+probeONVIFDevices().run({
+  ENABLE_IP_SCANNING: true
+}).subscribe(console.log)

src/ipscan.ts

@@ -0,0 +1,34 @@
+import { flatMap, map, catchError } from 'rxjs/operators'
+import { RxHR as http } from '@akanass/rx-http-request'
+import { ok, fail, maybe } from 'typescript-monads'
+import { forkJoin, of } from 'rxjs'
+import { ping } from 'ping-rx'
+import { networkInterfaces, NetworkInterfaceInfo } from 'os'
+
+const createNumList = (num: number) => Array.from(Array(num).keys())
+
+const interfaceDict = networkInterfaces()
+const userLocalIpNet = maybe(Object.keys(interfaceDict)
+  .reduce((acc: ReadonlyArray<NetworkInterfaceInfo>, curr) => [...acc, ...interfaceDict[curr]], [])
+  .filter(a => a.family === 'IPv4' && !a.internal)
+  .pop())
+  .map(c => c.address.split('.').slice(0, 3).join('.'))
+  .valueOr('192.168.1')
+
+export const ipscan = () => forkJoin(createNumList(256).map(num => ping(`${userLocalIpNet}.${num}`)()())).pipe(
+  map(res => res.filter(a => a.isOk()).map(a => `http://${a.unwrap().host}/onvif/device_service`)),
+  flatMap(urls => forkJoin(
+    urls.map(url => http.post(url, {
+      headers: { 'Content-Type': 'application/soap+xml; charset=utf-8;' },
+      body: '<Envelope xmlns="http://www.w3.org/2003/05/soap-envelope"><Body xmlns:xsd="http://www.w3.org/2001/XMLSchema"><GetSystemDateAndTime xmlns="http://www.onvif.org/ver10/device/wsdl"/></Body></Envelope>'
+    }).pipe(
+      map(res => {
+        return res.response.statusCode === 200
+          ? ok<string, string>(url)
+          : fail<string, string>('')
+      }),
+      catchError(err => of(fail(err)))
+    ))
+  )),
+  map(hosts => hosts.filter(b => b.isOk()).map(z => z.unwrap())))
+

src/parse.ts

@@ -7,6 +7,8 @@ const SCHEMAS = {
   discovery: 'http://schemas.xmlsoap.org/ws/2005/04/discovery'
 }
 
+export const maybeIpAddress = (str: string) => maybe(str.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/)).map(a => a[0])
+
 export const parseXmlResponse = (doc: Document) => (config: IProbeConfig): IONVIFDevice => {
   const simpleParse = (elm: Document | Element) => (ns: string) => (node: string) => maybe(elm.getElementsByTagNameNS(ns, node).item(0))
   const maybeRootProbeElement = maybe(doc.getElementsByTagNameNS(SCHEMAS.discovery, 'ProbeMatch').item(0))
@@ -40,8 +42,7 @@ export const parseXmlResponse = (doc: Document) => (config: IProbeConfig): IONVI
       .find(a => a.includes(`onvif/device_service`)))
       .valueOr('0.0.0.0')
 
-    const ip = maybe(deviceServiceUri.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/))
-      .map(a => a[0]).valueOr(deviceServiceUri)
+    const ip = maybeIpAddress(deviceServiceUri).valueOr(deviceServiceUri)
 
     return {
       name: valueFromScope('name'),