diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..402e17cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/bluepy.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/bluepy.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/bluepy" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/bluepy" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/assignednumbers.rst b/docs/assignednumbers.rst new file mode 100644 index 00000000..88197a1a --- /dev/null +++ b/docs/assignednumbers.rst @@ -0,0 +1,46 @@ +.. _assignednumbers: + +Assigned Numbers +================ + +The ``AssignedNumbers`` object is a convenient way to refer to common Bluetooth-related +Assigned Numbers by using textual names. So, for instance ``AssignedNumbers.firmwareRevisionString`` +is a ``UUID`` object for the `Firmware Revision String` characteristic identifier (0x2A26). + +The complete list of Bluetooth assigned numbers is given at https://www.bluetooth.org/en-us/specification/assigned-numbers + +The current version of `bluepy` includes the following defined values:: + + alertNotificationService + batteryLevel + batteryService + bloodPressure + currentTimeService + cyclingPower + cyclingSpeedAndCadence + deviceInformation + deviceName + firmwareRevisionString + genericAccess + genericAttribute + glucose + hardwareRevisionString + healthThermometer + heartRate + humanInterfaceDevice + immediateAlert + linkLoss + locationAndNavigation + manufacturerNameString + modelNumberString + nextDstChangeService + phoneAlertStatusService + referenceTimeUpdateService + runningSpeedAndCadence + scanParameters + serialNumberString + softwareRevisionString + txPower + txPowerLevel + userData + diff --git a/docs/characteristic.rst b/docs/characteristic.rst new file mode 100644 index 00000000..7bcd6d21 --- /dev/null +++ b/docs/characteristic.rst @@ -0,0 +1,35 @@ +.. _characteristic: + +The ``Characteristic`` class +============================ + +A Bluetooth LE "characteristic" represents a short data item which can be read or +written. These can be fixed (e.g. a string representing the manufacturer name) or +change dynamically (such as the current temperature or state of a button). Most +interaction with Bluetooth LE peripherals is done by reading or writing characteristics. + +Constructor +----------- + +You should not construct ``Characteristic`` objects directly. Instead, use the +``getCharacteristics()`` method of a connected ``Peripheral`` object. + +Instance Methods +---------------- + +.. function:: read() + + Reads the current value of a characteristic as a string of bytes. For Python 2.x this + is a value of type `str`, and on Python 3.x this is of type `bytes`. This may be + used with the `struct` module to extract integer values from the data. + + +.. function:: write(data, [withResponse=False]) + + Writes the given *data* to the characteristic. *data* should be of type `str` for + Python 2.x, and type `bytes` for Python 3.x. Bluetooth LE allows the sender to + request the peripheral to send a response to confirm that the data has been received. + Setting the *withResponse* parameter to *True* will make this request. A + `BTLEException` will be raised if the confirmation process fails. + + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..6f53e747 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,261 @@ +# -*- coding: utf-8 -*- +# +# bluepy documentation build configuration file, created by +# sphinx-quickstart on Fri Sep 5 10:07:35 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.todo', + 'sphinx.ext.ifconfig', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'bluepy' +copyright = u'2014, Ian Harvey' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bluepydoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'bluepy.tex', u'bluepy Documentation', + u'Ian Harvey', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'bluepy', u'bluepy Documentation', + [u'Ian Harvey'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'bluepy', u'bluepy Documentation', + u'Ian Harvey', 'bluepy', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/descriptor.rst b/docs/descriptor.rst new file mode 100644 index 00000000..e88b5cec --- /dev/null +++ b/docs/descriptor.rst @@ -0,0 +1,6 @@ +.. _descriptor: + +The ``Descriptor`` class +======================== + +The Descriptor class is a placeholder. ``bluepy`` does not currently support any useful operations with descriptors. diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..d616cbbe --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,33 @@ +.. bluepy documentation master file, created by + sphinx-quickstart on Fri Sep 5 10:07:35 2014. + + +``bluepy`` - a Bluetooth LE interface for Python +================================================ + +``bluepy`` is a Python module which allows communication with Bluetooth Low +Energy devices. The current implementation runs on Linux +(internally it uses code from the `BlueZ project `_), although it can be ported to other +platforms. + +To browse the API documentation, it is recommended to start with :ref:`peripheral`. + +Contents: + +.. toctree:: + :maxdepth: 2 + + peripheral + uuid + service + characteristic + descriptor + assignednumbers + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/peripheral.rst b/docs/peripheral.rst new file mode 100644 index 00000000..30e5fdfa --- /dev/null +++ b/docs/peripheral.rst @@ -0,0 +1,75 @@ +.. _peripheral: + +The ``Peripheral`` class +======================== + +Bluepy's ``Peripheral`` class encapsulates a connection to a Bluetooth LE peripheral. You create a ``Peripheral`` object directly by specifying its MAC address; when the connection is established, the services and characteristics offered by that device can be discovered and read or written. + +Constructor +----------- + +.. function:: Peripheral([deviceAddress=None]) + + If *deviceAddress* is not ``None``, creates a ``Peripheral`` object and makes a connection + to the device indicated by *deviceAddress* (which should be a string comprising six hex + bytes separated by colons, e.g. ``"11:22:33:ab:cd:ed"``). + + If *deviceAddress* is ``None``, creates an un-connected ``Peripheral`` object. You must call the ``connect()`` method on this object (passing it a device address) before it will be usable. + + The constructor will throw a ``BTLEException`` if connection to the device fails. + +Instance Methods +---------------- + +.. function:: connect(deviceAddress) + + Makes a connection to the device indicated by *deviceAddress*. You should only call + this method if the ``Peripheral`` is un-connected (i.e. you did not pass a *deviceAddress* + to the constructor); a given peripheral object cannot be re-connected once connected. + +.. function:: disconnect() + + Drops the connection to the device, and cleans up associated OS resources. Although the + Python destructor for a ``Peripheral`` will attempt to call this method, you should not + rely on this happening at any particular time. Therefore, always explicitly call + ``disconnect()`` if you have finished communicating with a device. + +.. function:: getServices() + + Returns a list of ``Service`` objects representing the services offered by the peripheral. + This will perform Bluetooth service discovery if this has not already been done; + otherwise it will return a cached list of services immediately. + +.. function:: getServiceByUUID(uuidVal): + + Returns an instance of a ``Service`` object which has the indicated UUID. + ``uuidVal`` can be a ``UUID`` object, or any string or integer which can be + used to construct a ``UUID`` object. The method will return immediately if the + service was previously discovered (e.g. by *getServices()*), and will query + the peripheral otherwise. It raises a *BTLEEException* if the service is not + found. + +.. function:: getCharacteristics(startHnd=1, endHnd=0xFFFF, uuid=None): + + Returns a list containing ``Characteristic`` objects for the peripheral. If no + arguments are given, will return all characteristics. If *startHnd* and/or + *endHnd* are given, the list is restricted to characteristics whose handles are + within the given range - note that it's usually more convenient to use + ``Service.getCharacteristics()`` to get the characteristics associated with + a particular service. Alternatively, *uuid* may be specified to locate a + characteristic with a particular UUID value. *uuid* may be any string, integer, + or ``UUID`` type which can be used to construct a ``UUID`` object. + + If no matching characteristics are found, returns an empty list. + +.. function:: getDescriptors(startHnd=1, endHnd=0xFFFF): + + Returns a list containing ``Descriptor`` objects for the peripheral. If no + arguments are given, will return all descriptors. If *startHnd* and/or + *endHnd* are given, the list is restricted to descriptors whose handles are + within the given range. Again, it's usually more convenient to use + ``Service.getDescriptors()`` to get the descriptors associated with + a particular service. + + If no matching descriptors are found, returns an empty list. + diff --git a/docs/service.rst b/docs/service.rst new file mode 100644 index 00000000..7db39b37 --- /dev/null +++ b/docs/service.rst @@ -0,0 +1,29 @@ +.. _service: + +The ``Service`` class +===================== + +A Bluetooth LE ``Service`` object represents a collection of `characteristics` and +`descriptors` which are all related to one particular function of the peripheral. This +allows particular characteristics to be discovered without having to enumerate everything offered by that peripheral. + +More information about standard services can be found at +https://www.bluetooth.org/en-us/specification/adopted-specifications + +Constructor +----------- + +You should not construct ``Service`` objects directly. Instead, use the +``getServices()`` or ``getServiceByUUID()`` methods of a connected ``Peripheral`` object. + + +Instance Methods +---------------- + +.. function:: getCharacteristics([forUUID=None]) + + Returns a list of ``Characteristic`` objects associated with the service. If this + has not been done before, the peripheral is queried. Otherwise, a cached list if + returned. If *forUUID* is given, it may be a ``UUID`` object or a value used to + construct one. In this case the returned list, which may be empty, contains any + characteristics associated with the service which match that UUID. diff --git a/docs/uuid.rst b/docs/uuid.rst new file mode 100644 index 00000000..bebfc367 --- /dev/null +++ b/docs/uuid.rst @@ -0,0 +1,24 @@ +The ``UUID`` class +================== + +Constructor +----------- + +.. function:: UUID(value) + + Constructs a ``UUID`` object with the given *value*. This may be: + + * an `int` value in the range 0 to 0xFFFFFFFF + * a `str` value + * another `UUID` object + * any other value which can be converted to hex digits using ``str()`` + +Instance Methods +---------------- + +.. function:: getCommonName() + + Returns string describing that UUID. If the UUID is one listed + in :ref:`assignednumbers` this will be a human-readable name e.g. + "Cycling Speed and Cadence". Otherwise, it will be a hexadecimal string. +