Browse Source

More naming changes.

pyserial_fix
Scott Petersen 11 years ago
parent
commit
3ad13539d8
7 changed files with 18 additions and 18 deletions
  1. +4
    -4
      docs/Makefile
  2. +1
    -1
      docs/index.rst
  3. +2
    -2
      docs/make.bat
  4. +4
    -4
      pyad2/ad2.py
  5. +3
    -3
      pyad2/devices.py
  6. +1
    -1
      pyad2/messages.py
  7. +3
    -3
      pyad2/util.py

+ 4
- 4
docs/Makefile View File

@@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyad2usb.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyad2.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyad2usb.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyad2.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyad2usb"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyad2usb"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyad2"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyad2"
@echo "# devhelp"

epub:


+ 1
- 1
docs/index.rst View File

@@ -1,4 +1,4 @@
.. pyad2usb documentation master file, created by
.. pyad2 documentation master file, created by
sphinx-quickstart on Sat Jun 8 14:38:46 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.


+ 2
- 2
docs/make.bat View File

@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyad2usb.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyad2.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyad2usb.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyad2.ghc
goto end
)


+ 4
- 4
pyad2/ad2.py View File

@@ -1,5 +1,5 @@
"""
Provides the full AD2USB class and factory.
Provides the full AD2 class and factory.

.. moduleauthor:: Scott Petersen <scott@nutech.com>
"""
@@ -171,7 +171,7 @@ class Overseer(object):

class AD2(object):
"""
High-level wrapper around AD2USB/AD2SERIAL devices.
High-level wrapper around AD2 devices.
"""

# High-level Events
@@ -219,7 +219,7 @@ class AD2(object):
"""
Constructor

:param device: The low-level device used for this AD2USB interface.
:param device: The low-level device used for this AD2 interface.
:type device: devices.Device
"""
self._device = device
@@ -245,7 +245,7 @@ class AD2(object):
@property
def id(self):
"""
The ID of the AD2USB device.
The ID of the AD2 device.

:returns: The identification string for the device.
"""


+ 3
- 3
pyad2/devices.py View File

@@ -1,5 +1,5 @@
"""
Contains different types of devices belonging to the AD2USB family.
Contains different types of devices belonging to the AD2 family.

.. moduleauthor:: Scott Petersen <scott@nutech.com>
"""
@@ -17,7 +17,7 @@ from .event import event

class Device(object):
"""
Generic parent device to all AD2USB products.
Generic parent device to all AD2 products.
"""

# Generic device events
@@ -610,7 +610,7 @@ class SerialDevice(Device):

class SocketDevice(Device):
"""
Device that supports communication with an AD2USB that is exposed via ser2sock or another
Device that supports communication with an AD2 that is exposed via ser2sock or another
Serial to IP interface.
"""



+ 1
- 1
pyad2/messages.py View File

@@ -1,5 +1,5 @@
"""
Message representations received from the panel through the AD2USB.
Message representations received from the panel through the AD2 devices.

.. moduleauthor:: Scott Petersen <scott@nutech.com>
"""


+ 3
- 3
pyad2/util.py View File

@@ -1,5 +1,5 @@
"""
Provides utility classes for the AD2USB devices.
Provides utility classes for the AD2 devices.

.. moduleauthor:: Scott Petersen <scott@nutech.com>
"""
@@ -35,7 +35,7 @@ class InvalidMessageError(Exception):

class Firmware(object):
"""
Represents firmware for the AD2USB/AD2SERIAL devices.
Represents firmware for the AD2 devices.
"""

# Constants
@@ -49,7 +49,7 @@ class Firmware(object):
@staticmethod
def upload(dev, filename, progress_callback=None):
"""
Uploads firmware to an AD2USB/AD2SERIAL device.
Uploads firmware to an AD2 device.

:param filename: The firmware filename
:type filename: str


Loading…
Cancel
Save