Skip to content

Commit

Permalink
Issue #19: Correct i2c_read data return comment
Browse files Browse the repository at this point in the history
  • Loading branch information
@MrYsLab
MrYsLab committed May 11, 2024
1 parent efb8d78 commit 62ef560
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 27 deletions.
42 changes: 21 additions & 21 deletions html/telemetrix_aio/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ <h1 class="title">Module <code>telemetrix_aio.telemetrix_aio</code></h1>
self.stepper_info_list = []
# a list of dictionaries to hold stepper information
for motor in range(self.max_number_of_steppers):
self.stepper_info_list.append(self.stepper_info)
self.stepper_info_list.append(self.stepper_info.copy())

print(f&#39;TelemetrixAIO Version: {PrivateConstants.TELEMETRIX_AIO_VERSION}&#39;)
print(f&#39;Copyright (c) 2018-2023 Alan Yorinks All rights reserved.\n&#39;)
Expand Down Expand Up @@ -553,8 +553,8 @@ <h1 class="title">Module <code>telemetrix_aio.telemetrix_aio</code></h1>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -594,8 +594,8 @@ <h1 class="title">Module <code>telemetrix_aio.telemetrix_aio</code></h1>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -990,7 +990,7 @@ <h1 class="title">Module <code>telemetrix_aio.telemetrix_aio</code></h1>
&#34;&#34;&#34;
if self.reported_features &amp; PrivateConstants.SPI_FEATURE:

if type(chip_select_list) != list:
if type(chip_select_list) is not list:
if self.shutdown_on_exception:
await self.shutdown()
raise RuntimeError(&#39;chip_select_list must be in the form of a list&#39;)
Expand Down Expand Up @@ -2832,7 +2832,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
self.stepper_info_list = []
# a list of dictionaries to hold stepper information
for motor in range(self.max_number_of_steppers):
self.stepper_info_list.append(self.stepper_info)
self.stepper_info_list.append(self.stepper_info.copy())

print(f&#39;TelemetrixAIO Version: {PrivateConstants.TELEMETRIX_AIO_VERSION}&#39;)
print(f&#39;Copyright (c) 2018-2023 Alan Yorinks All rights reserved.\n&#39;)
Expand Down Expand Up @@ -3081,8 +3081,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -3122,8 +3122,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -3518,7 +3518,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;&#34;&#34;
if self.reported_features &amp; PrivateConstants.SPI_FEATURE:

if type(chip_select_list) != list:
if type(chip_select_list) is not list:
if self.shutdown_on_exception:
await self.shutdown()
raise RuntimeError(&#39;chip_select_list must be in the form of a list&#39;)
Expand Down Expand Up @@ -5291,8 +5291,8 @@ <h3>Methods</h3>
before read
Else, the write is suppressed</p>
<p>callback returns a data list:</p>
<p>[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]</p></div>
<p>[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read&hellip;, time-stamp]</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
Expand Down Expand Up @@ -5323,8 +5323,8 @@ <h3>Methods</h3>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -5355,8 +5355,8 @@ <h3>Methods</h3>
before read
Else, the write is suppressed</p>
<p>callback returns a data list:</p>
<p>[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]</p></div>
<p>[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read&hellip;, time-stamp]</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
Expand Down Expand Up @@ -5389,8 +5389,8 @@ <h3>Methods</h3>

callback returns a data list:

[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]

&#34;&#34;&#34;
if not callback:
Expand Down Expand Up @@ -6274,7 +6274,7 @@ <h3>Methods</h3>
&#34;&#34;&#34;
if self.reported_features &amp; PrivateConstants.SPI_FEATURE:

if type(chip_select_list) != list:
if type(chip_select_list) is not list:
if self.shutdown_on_exception:
await self.shutdown()
raise RuntimeError(&#39;chip_select_list must be in the form of a list&#39;)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ find = {} # Scan the project directory with the default parameters

[project]
name = "telemetrix-aio"
version = "1.23"
version = "1.24"
authors = [
{ name="Alan Yorinks", email="[email protected]" },
]
Expand Down
2 changes: 1 addition & 1 deletion telemetrix_aio/private_constants.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class PrivateConstants:

DEBUG_PRINT = 99

TELEMETRIX_AIO_VERSION = "1.23"
TELEMETRIX_AIO_VERSION = "1.24"

# reporting control
REPORTING_DISABLE_ALL = 0
Expand Down
8 changes: 4 additions & 4 deletions telemetrix_aio/telemetrix_aio.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,8 +510,8 @@ async def i2c_read(self, address, register, number_of_bytes,
callback returns a data list:
[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]
"""
if not callback:
Expand Down Expand Up @@ -551,8 +551,8 @@ async def i2c_read_restart_transmission(self, address, register,
callback returns a data list:
[I2C_READ_REPORT, address, register, count of data bytes,
data bytes, time-stamp]
[I2C_READ_REPORT, i2c_port, number of bytes read, address, register,
bytes read..., time-stamp]
"""
if not callback:
Expand Down

0 comments on commit 62ef560

Please sign in to comment.