Add pod-doc

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 icons.sketch
+/doc/
 /fan.props
 /lib/
 /temp/

changelog.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## Version 0.4 (working)
+* Add pod-doc
+* Fix NPE with `dispatchSync` on background actor
 
 ## Version 0.3 (16-Jun-2020)
 * Misc fixes to make sync more reliable

src/novantExt/pod.fandoc

@@ -0,0 +1,75 @@
+**************************************************************************
+** title:      NovantExt
+** author:     Andy Frank
+** created:    17 Jun 2020
+** copyright:  Copyright (c) 2020, Novant LLC, All Rights Reserved
+**************************************************************************
+
+Overview [#overview]
+********************
+The NovantExt implements connector support for the [Novant]`https://novant.io`
+Smart Building PaaS.
+
+API Keys [#apiKeys]
+********************************
+Access to Novant devices are built around API keys. It's recommended you
+create a specific API key just for SkySpark access.
+
+Connectors [#conns]
+*******************
+Each connector in SkySpark maps 1:1 to a Novant device.  To create and map a
+new connector:
+
+  novantConn
+  dis: "My Device"
+  apiKey: "***********"
+  novantDeviceId: dv_xxxxxxxxxxxxx
+  novantSyncFreq: "daily"
+
+Where 'apiKey' is the key you generated from the Novant platform, and
+'novantDeviceId' is the Novant device id for the device to connect. See
+**Syncing** section for details on 'novantSyncFreq'.
+
+Cur/Write/His [#curHisWrite]
+****************************
+Novant devices are somewhat unique in that they *only* support 'his' points.
+There is no 'curVal' and points are not writable.
+
+Learn [#learn]
+**************
+The Novant connector supports learning.  Once a connector has been added, you
+can use the Site Builder to walk the device tree and add any or all points.
+
+Syncing [#sync]
+***************
+The Novant extension is designed to automate history syncs to simplify keeping
+data up-to-date.  Syncing is managed on the *connector* instead of *per-point*.
+The default is to sync trend data for all points under a connector daily. A new
+connector will being syncing history 'yesterday'.  If you wish to sync previous
+data that is available, see the **Conn Tool** section below.
+
+By design, the Novant platform trends data "day-behind."  Which means your
+latest data will be up to midnight yesterday.  Once you have created a new
+connector, the ext will automatically keep it up-to-date.
+
+In cases where this is not desirable, you can disable auto-sync by setting the
+'novantSyncFreq' on a connector to '"none"'.  You can manually sync these
+connectors using the **Conn Tool**.
+
+Conn Tool [#connTool]
+*********************
+The Novant Conn Tool provides a single view to manage your device connectors.
+This view will list all the current connectors in a table with easy to scan
+diagnostic information.
+
+Sync History [#connToolSync]
+============================
+The Sync History action will force a manual history sync for a given date
+range. This can be used to sync previous data before the connector was created
+in SkySpark. Syncing is optimized to skip days where data was already synced.
+
+Clear History [#connToolClear]
+==============================
+To remove all history for all points under a connector, use the Clear History
+action.  This only effects history in SkySpark.  The data from the Novant
+platform can be resynced.