Update doc

msvargas · Oct 6, 2019 · ae2f99b · ae2f99b
1 parent d1a2db8
commit ae2f99b
Show file tree

Hide file tree

Showing 49 changed files with 11,893 additions and 4,641 deletions.
diff --git a/README.md b/README.md
@@ -153,9 +153,9 @@ function _replacePin(str = "", pin) {
 
 ## More Examples
 
-[NodeJS](https://github.com/punisher97/node-logix/tree/master/examples):
+- Own: [NodeJS](https://github.com/punisher97/node-logix/tree/master/examples)
 
-[Python](https://github.com/dmroeder/pylogix/tree/master/pylogix/examples)
+- Third-party: [Python](https://github.com/dmroeder/pylogix/tree/master/pylogix/examples)
 
 # NOTE:
 

diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/_src_eip_pool_.eipsocketpool.html b/docs/classes/_src_eip_pool_.eipsocketpool.html
diff --git a/docs/classes/eipcontext.html → .../classes/_src_eip_socket_.eipcontext.html b/docs/classes/eipcontext.html → .../classes/_src_eip_socket_.eipcontext.html
diff --git a/docs/classes/eipsocket.html → docs/classes/_src_eip_socket_.eipsocket.html b/docs/classes/eipsocket.html → docs/classes/_src_eip_socket_.eipsocket.html
diff --git a/docs/classes/lgxresponse.html → ...classes/_src_eip_socket_.lgxresponse.html b/docs/classes/lgxresponse.html → ...classes/_src_eip_socket_.lgxresponse.html
diff --git a/docs/classes/lgxtag.html → docs/classes/_src_eip_socket_.lgxtag.html b/docs/classes/lgxtag.html → docs/classes/_src_eip_socket_.lgxtag.html
diff --git a/docs/classes/connectionerror.html → ...classes/_src_errors_.connectionerror.html b/docs/classes/connectionerror.html → ...classes/_src_errors_.connectionerror.html
diff --git a/docs/classes/connectionlosterror.html → ...ses/_src_errors_.connectionlosterror.html b/docs/classes/connectionlosterror.html → ...ses/_src_errors_.connectionlosterror.html
diff --git a/docs/classes/connectiontimeouterror.html → .../_src_errors_.connectiontimeouterror.html b/docs/classes/connectiontimeouterror.html → .../_src_errors_.connectiontimeouterror.html
diff --git a/docs/classes/disconnectederror.html → ...asses/_src_errors_.disconnectederror.html b/docs/classes/disconnectederror.html → ...asses/_src_errors_.disconnectederror.html
diff --git a/docs/classes/forwaropenerror.html → ...classes/_src_errors_.forwaropenerror.html b/docs/classes/forwaropenerror.html → ...classes/_src_errors_.forwaropenerror.html
diff --git a/docs/classes/logixerror.html → docs/classes/_src_errors_.logixerror.html b/docs/classes/logixerror.html → docs/classes/_src_errors_.logixerror.html
diff --git a/docs/classes/pinmappingerror.html → ...classes/_src_errors_.pinmappingerror.html b/docs/classes/pinmappingerror.html → ...classes/_src_errors_.pinmappingerror.html
diff --git a/docs/classes/registersessionerror.html → ...es/_src_errors_.registersessionerror.html b/docs/classes/registersessionerror.html → ...es/_src_errors_.registersessionerror.html
diff --git a/docs/classes/valueerror.html → docs/classes/_src_errors_.valueerror.html b/docs/classes/valueerror.html → docs/classes/_src_errors_.valueerror.html
diff --git a/docs/classes/lgxdevice.html → docs/classes/_src_lgxdevice_.lgxdevice.html b/docs/classes/lgxdevice.html → docs/classes/_src_lgxdevice_.lgxdevice.html
diff --git a/docs/classes/pin.html → docs/classes/_src_plc_.pin.html b/docs/classes/pin.html → docs/classes/_src_plc_.pin.html
diff --git a/docs/classes/_src_plc_.plc.html b/docs/classes/_src_plc_.plc.html
diff --git a/docs/enums/ciptypesvalues.html → docs/enums/_src_plc_.ciptypesvalues.html b/docs/enums/ciptypesvalues.html → docs/enums/_src_plc_.ciptypesvalues.html
diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
@@ -38,6 +38,10 @@
 							</div>
 							<input type="checkbox" id="tsd-filter-inherited" checked />
 							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
+							<input type="checkbox" id="tsd-filter-externals" checked />
+							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
+							<input type="checkbox" id="tsd-filter-only-exported" />
+							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
 						</div>
 					</div>
 					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -238,132 +242,57 @@ <h2>License</h2>
 					<li class="globals  ">
 						<a href="globals.html"><em>Globals</em></a>
 					</li>
-				</ul>
-			</nav>
-			<nav class="tsd-navigation secondary menu-sticky">
-				<ul class="before-current">
-					<li class=" tsd-kind-enum">
-						<a href="enums/ciptypesvalues.html" class="tsd-kind-icon">CIPTypes<wbr>Values</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/connectionerror.html" class="tsd-kind-icon">Connection<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/connectionlosterror.html" class="tsd-kind-icon">Connection<wbr>Lost<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/connectiontimeouterror.html" class="tsd-kind-icon">Connection<wbr>Timeout<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/disconnectederror.html" class="tsd-kind-icon">Disconnected<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/eipcontext.html" class="tsd-kind-icon">EIPContext</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/eipsocket.html" class="tsd-kind-icon">EIPSocket</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/forwaropenerror.html" class="tsd-kind-icon">Forwar<wbr>Open<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/lgxdevice.html" class="tsd-kind-icon">LGXDevice</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/lgxresponse.html" class="tsd-kind-icon">Lgx<wbr>Response</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/lgxtag.html" class="tsd-kind-icon">Lgx<wbr>Tag</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/logixerror.html" class="tsd-kind-icon">Logix<wbr>Error</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/pin.html" class="tsd-kind-icon">Pin</a>
-					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/pinmappingerror.html" class="tsd-kind-icon">Pin<wbr>Mapping<wbr>Error</a>
+					<li class="label tsd-is-external">
+						<span>Internals</span>
 					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/registersessionerror.html" class="tsd-kind-icon">Register<wbr>Session<wbr>Error</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_plc_.html">"src/PLC"</a>
 					</li>
-					<li class=" tsd-kind-class">
-						<a href="classes/valueerror.html" class="tsd-kind-icon">Value<wbr>Error</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_eip_pool_.html">"src/eip-<wbr>pool"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/iciptypes.html" class="tsd-kind-icon">ICIPTypes</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_eip_socket_.html">"src/eip-<wbr>socket"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/icustomsocket.html" class="tsd-kind-icon">ICustom<wbr>Socket</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_errors_.html">"src/errors"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/ideviceprops.html" class="tsd-kind-icon">IDevice<wbr>Props</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_index_.html">"src/index"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/idiscoveroptions.html" class="tsd-kind-icon">IDiscover<wbr>Options</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_lgxdevice_.html">"src/lgx<wbr>Device"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/ieipcontextoptions.html" class="tsd-kind-icon">IEIPContext<wbr>Options</a>
+					<li class=" tsd-kind-external-module">
+						<a href="modules/_src_utils_.html">"src/utils"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/iknowntags.html" class="tsd-kind-icon">IKnown<wbr>Tags</a>
+					<li class="label tsd-is-external">
+						<span>Externals</span>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/ilgxdevice.html" class="tsd-kind-icon">ILGXDevice</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_cipcontext_.html">"resources/CIPContext"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/ioptions.html" class="tsd-kind-icon">IOptions</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_ciperrorcodes_.html">"resources/CIPError<wbr>Codes"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/ipingmappings.html" class="tsd-kind-icon">IPing<wbr>Mappings</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_ciptypes_.html">"resources/CIPTypes"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/itagreadoptions.html" class="tsd-kind-icon">ITag<wbr>Read<wbr>Options</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_devices_.html">"resources/devices"</a>
 					</li>
-					<li class=" tsd-kind-interface">
-						<a href="interfaces/itagwriteoptions.html" class="tsd-kind-icon">ITag<wbr>Write<wbr>Options</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_pin_mapping_.html">"resources/pin-<wbr>mapping"</a>
 					</li>
-					<li class=" tsd-kind-type-alias">
-						<a href="globals.html#ciptype" class="tsd-kind-icon">CIPType</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#bitvalue" class="tsd-kind-icon">Bit<wbr>Value</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#bitofword" class="tsd-kind-icon">Bitof<wbr>Word</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#_replacepin" class="tsd-kind-icon">_replace<wbr>Pin</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#flatten" class="tsd-kind-icon">flatten</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#getbitofword" class="tsd-kind-icon">get<wbr>Bit<wbr>OfWord</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#getdevice" class="tsd-kind-icon">get<wbr>Device</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#geterrorcode" class="tsd-kind-icon">get<wbr>Error<wbr>Code</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#getvendor" class="tsd-kind-icon">get<wbr>Vendor</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#getwordcount" class="tsd-kind-icon">get<wbr>Word<wbr>Count</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#namefunction" class="tsd-kind-icon">name<wbr>Function</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#parseidentityresponse" class="tsd-kind-icon">parse<wbr>Identity<wbr>Response</a>
-					</li>
-					<li class=" tsd-kind-function">
-						<a href="globals.html#parsetagname" class="tsd-kind-icon">parse<wbr>Tag<wbr>Name</a>
+					<li class=" tsd-kind-external-module tsd-is-external">
+						<a href="modules/_resources_vendors_.html">"resources/vendors"</a>
 					</li>
 				</ul>
 			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+			</nav>
 		</div>
 	</div>
 </div>