Skip to content

Commit 793c1a1

Browse files
sanny32sanny32
committed
update docs
1 parent 2e74251 commit 793c1a1

4 files changed

Lines changed: 102 additions & 118 deletions

File tree

‎omodsim/docs/index.html‎

Lines changed: 51 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ <h1 class="title">JavaScript Help</h1>
136136
<ul class="level2">
137137
<li><a href="#server.addressbase">Server.addressBase</a></li>
138138
<li><a href="#server.onchange">Server.onChange</a></li>
139+
<li><a href="#server.onError">Server.onError</a></li>
139140
<li><a href="#server.readcoil">Server.readCoil</a></li>
140141
<li><a href="#server.readdiscrete">Server.readDiscrete</a></li>
141142
<li><a href="#server.readinput">Server.readInput</a></li>
@@ -646,130 +647,134 @@ <h1 id="server">Server</h1>
646647
</dd>
647648
</dl>
648649
<section aria-labelledby="static_methods"><h2 id="server.static_methods">Static methods</h2><div class="section-content"><dl>
649-
<dt id="server.onchange"><code>Server.onChange(Register, address, functionRef)</code></dt>
650+
<dt id="server.onchange"><code>Server.onChange(deviceId, Register, address, functionRef)</code></dt>
650651
<dd>
651-
<p>Executes a <code>functionRef(value)</code> when a <code>Register</code> value at <code>address</code> was changed.</p>
652+
<p>Executes a <code>functionRef(value)</code> when a <code>Register</code> value at <code>address</code> with <code>deviceId</code> was changed.</p>
652653
</dd>
653-
<dt id="server.readcoil"><code>Server.readCoil(address)</code></dt>
654+
<dt id="server.onError"><code>Server.onError(deviceId, functionRef)</code></dt>
654655
<dd>
655-
<p>Returns a Coil register value at <code>address</code>.</p>
656+
<p>Executes a <code>functionRef(error)</code> when an error occurred for <code>deviceId</code>.</p>
656657
</dd>
657-
<dt id="server.readdiscrete"><code>Server.readDiscrete(address)</code></dt>
658+
<dt id="server.readcoil"><code>Server.readCoil(address, deviceId)</code></dt>
658659
<dd>
659-
<p>Returns a Discrete register value at <code>address</code>.</p>
660+
<p>Returns a Coil register value at <code>address</code> with <code>deviceId</code>.</p>
660661
</dd>
661-
<dt id="server.readinput"><code>Server.readInput(address)</code></dt>
662+
<dt id="server.readdiscrete"><code>Server.readDiscrete(address, deviceId)</code></dt>
662663
<dd>
663-
<p>Returns a Input register value at <code>address</code>.</p>
664+
<p>Returns a Discrete register value at <code>address</code> with <code>deviceId</code>.</p>
664665
</dd>
665-
<dt id="server.readholding"><code>Server.readHolding(address)</code></dt>
666+
<dt id="server.readinput"><code>Server.readInput(address, deviceId)</code></dt>
666667
<dd>
667-
<p>Returns a Holding register value at <code>address</code>.</p>
668+
<p>Returns a Input register value at <code>address</code> with <code>deviceId</code>.</p>
668669
</dd>
669-
<dt id="server.readansi"><code>Server.readAnsi(Register, address, codepage)</code></dt>
670+
<dt id="server.readholding"><code>Server.readHolding(address, deviceId)</code></dt>
670671
<dd>
671-
<p>Returns a register value at <code>address</code> as 2 ANSI symbols with <code>codepage</code>.</p>
672+
<p>Returns a Holding register value at <code>address</code> with <code>deviceId</code>.</p>
672673
</dd>
673-
<dt id="server.readint32"><code>Server.readInt32(Register, address, swapped)</code></dt>
674+
<dt id="server.readansi"><code>Server.readAnsi(Register, address, codepage, deviceId)</code></dt>
674675
<dd>
675-
<p>Returns a 32-bit integer value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 32-bit integer value.</p>
676+
<p>Returns a register value at <code>address</code> as 2 ANSI symbols with <code>codepage</code> for <code>deviceId</code>.</p>
677+
</dd>
678+
<dt id="server.readint32"><code>Server.readInt32(Register, address, swapped, deviceId)</code></dt>
679+
<dd>
680+
<p>Returns a 32-bit integer value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 32-bit integer value.</p>
676681
<div class="notecard note">
677682
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
678683
</div>
679684
</dd>
680-
<dt id="server.readint64"><code>Server.readInt64(Register, address, swapped)</code></dt>
685+
<dt id="server.readint64"><code>Server.readInt64(Register, address, swapped, deviceId)</code></dt>
681686
<dd>
682-
<p>Returns a 64-bit integer value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 64-bit integer value.</p>
687+
<p>Returns a 64-bit integer value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 64-bit integer value.</p>
683688
<div class="notecard note">
684689
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
685690
</div>
686691
</dd>
687-
<dt id="server.readuint32"><code>Server.readUInt32(Register, address, swapped)</code></dt>
692+
<dt id="server.readuint32"><code>Server.readUInt32(Register, address, swapped, deviceId)</code></dt>
688693
<dd>
689-
<p>Returns a 32-bit unsigned integer value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 32-bit unsigned integer value.</p>
694+
<p>Returns a 32-bit unsigned integer value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 32-bit unsigned integer value.</p>
690695
<div class="notecard note">
691696
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
692697
</div>
693698
</dd>
694-
<dt id="server.readuint64"><code>Server.readUInt64(Register, address, swapped)</code></dt>
699+
<dt id="server.readuint64"><code>Server.readUInt64(Register, address, swapped, deviceId)</code></dt>
695700
<dd>
696-
<p>Returns a 64-bit unsigned integer value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 64-bit unsigned integer value.</p>
701+
<p>Returns a 64-bit unsigned integer value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a 64-bit unsigned integer value.</p>
697702
<div class="notecard note">
698703
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
699704
</div>
700705
</dd>
701-
<dt id="server.readdouble"><code>Server.readDouble(Register, address, swapped)</code></dt>
706+
<dt id="server.readdouble"><code>Server.readDouble(Register, address, swapped, deviceId)</code></dt>
702707
<dd>
703-
<p>Returns a double value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a double value.</p>
708+
<p>Returns a double value from <code>address</code> to <code>address + 3</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a double value.</p>
704709
<div class="notecard note">
705710
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
706711
</div>
707712
</dd>
708-
<dt id="server.readfloat"><code>Server.readFloat(Register, address, swapped)</code></dt>
713+
<dt id="server.readfloat"><code>Server.readFloat(Register, address, swapped, deviceId)</code></dt>
709714
<dd>
710-
<p>Returns a float value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a float value.</p>
715+
<p>Returns a float value from <code>address</code> to <code>address + 1</code> registers type <code>Register</code> with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert set of registers to a float value.</p>
711716
<div class="notecard note">
712717
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
713718
</div>
714719
</dd>
715-
<dt id="server.writecoil"><code>Server.writeCoil(address, value)</code></dt>
720+
<dt id="server.writecoil"><code>Server.writeCoil(address, value, deviceId)</code></dt>
716721
<dd>
717-
<p>Writes a <code>value</code> to the Coil register at <code>address</code>.</p>
722+
<p>Writes a <code>value</code> to the Coil register at <code>address</code> with <code>deviceId</code>.</p>
718723
</dd>
719-
<dt id="server.writediscrete"><code>Server.writeDiscrete(address, value)</code></dt>
724+
<dt id="server.writediscrete"><code>Server.writeDiscrete(address, value, deviceId)</code></dt>
720725
<dd>
721-
<p>Writes a <code>value</code> to the Discrete register at <code>address</code>.</p>
726+
<p>Writes a <code>value</code> to the Discrete register at <code>address</code> with <code>deviceId</code>.</p>
722727
</dd>
723-
<dt id="server.writeinput"><code>Server.writeInput(address, value)</code></dt>
728+
<dt id="server.writeinput"><code>Server.writeInput(address, value, deviceId)</code></dt>
724729
<dd>
725-
<p>Writes a <code>value</code> to the Input register at <code>address</code>.</p>
730+
<p>Writes a <code>value</code> to the Input register at <code>address</code> with <code>deviceId</code>.</p>
726731
</dd>
727-
<dt id="server.writeholding"><code>Server.writeHolding(address, value)</code></dt>
732+
<dt id="server.writeholding"><code>Server.writeHolding(address, value, deviceId)</code></dt>
728733
<dd>
729-
<p>Writes a <code>value</code> to the Holding register at <code>address</code>.</p>
734+
<p>Writes a <code>value</code> to the Holding register at <code>address</code> with <code>deviceId</code>.</p>
730735
</dd>
731-
<dt id="server.writeansi"><code>Server.writeAnsi(Register, address, value, codepage)</code></dt>
736+
<dt id="server.writeansi"><code>Server.writeAnsi(Register, address, value, codepage, deviceId)</code></dt>
732737
<dd>
733-
<p>Writes a <code>value</code> to the register at <code>address</code> as 2 ANSI symbols coded with <code>codepage</code>.</p>
738+
<p>Writes a <code>value</code> to the register at <code>address</code> as 2 ANSI symbols coded with <code>codepage</code> for <code>deviceId</code>.</p>
734739
</dd>
735-
<dt id="server.writeint32"><code>Server.writeInt32(Register, address, value, swapped)</code></dt>
740+
<dt id="server.writeint32"><code>Server.writeInt32(Register, address, value, swapped, deviceId)</code></dt>
736741
<dd>
737-
<p>Writes a 32-bit integer <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a 32-bit integer value to the set of registers.</p>
742+
<p>Writes a 32-bit integer <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a 32-bit integer value to the set of registers.</p>
738743
<div class="notecard note">
739744
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
740745
</div>
741746
</dd>
742-
<dt id="server.writeint64"><code>Server.writeInt64(Register, address, value, swapped)</code></dt>
747+
<dt id="server.writeint64"><code>Server.writeInt64(Register, address, value, swapped, deviceId)</code></dt>
743748
<dd>
744-
<p>Writes a 64-bit integer <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a 64-bit integer value to the set of registers.</p>
749+
<p>Writes a 64-bit integer <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a 64-bit integer value to the set of registers.</p>
745750
<div class="notecard note">
746751
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
747752
</div>
748753
</dd>
749-
<dt id="server.writeunint32"><code>Server.writeUInt32(Register, address, value, swapped)</code></dt>
754+
<dt id="server.writeunint32"><code>Server.writeUInt32(Register, address, value, swapped, deviceId)</code></dt>
750755
<dd>
751-
<p>Writes a 32-bit unsigned integer <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a 32-bit unsigned integer value to the set of registers.</p>
756+
<p>Writes a 32-bit unsigned integer <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a 32-bit unsigned integer value to the set of registers.</p>
752757
<div class="notecard note">
753758
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
754759
</div>
755760
</dd>
756-
<dt id="server.writeunint64"><code>Server.writeUInt64(Register, address, value, swapped)</code></dt>
761+
<dt id="server.writeunint64"><code>Server.writeUInt64(Register, address, value, swapped, deviceId)</code></dt>
757762
<dd>
758-
<p>Writes a 64-bit unsigned integer <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a 64-bit unsigned integer value to the set of registers.</p>
763+
<p>Writes a 64-bit unsigned integer <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a 64-bit unsigned integer value to the set of registers.</p>
759764
<div class="notecard note">
760765
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
761766
</div>
762767
</dd>
763-
<dt id="server.writedouble"><code>Server.writeDouble(Register, address, value, swapped)</code></dt>
768+
<dt id="server.writedouble"><code>Server.writeDouble(Register, address, value, swapped, deviceId)</code></dt>
764769
<dd>
765-
<p>Writes a double <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a double value to the set of registers.</p>
770+
<p>Writes a double <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a double value to the set of registers.</p>
766771
<div class="notecard note">
767772
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
768773
</div>
769774
</dd>
770-
<dt id="server.writefloat"><code>Server.writeFloat(Register, address, value, swapped)</code></dt>
775+
<dt id="server.writefloat"><code>Server.writeFloat(Register, address, value, swapped, deviceId)</code></dt>
771776
<dd>
772-
<p>Writes a float <code>value</code> to the <code>Register</code> addresses. The <code>swapped</code> parameter change the registers order, when function convert a float value to the set of registers.</p>
777+
<p>Writes a float <code>value</code> to the <code>Register</code> addresses with <code>deviceId</code>. The <code>swapped</code> parameter change the registers order, when function convert a float value to the set of registers.</p>
773778
<div class="notecard note">
774779
<p><strong>Note:</strong> This function is available only for <code>Register.Input</code> and <code>Register.Holding</code> registers.</p>
775780
</div>

0 commit comments

Comments
 (0)