Module urest.examples

Examples of the module use, both as simple applications and as helper classes for reuse in more complete applications

Overview

This is a collection of examples, utility classes and other scraps of code which demonstrate the use of the library in common applications. Many of these examples will require extension, or further development in real applications. However they should give some idea of what those more complete applications may look like.

Tested Implementations

This version is written for MicroPython 3.4, and has been tested on:

• Raspberry Pi Pico W

Licence

This module, and all included code, is made available under the terms of the MIT Licence

Copyright 2021–2022 (c) Erik de Lange, Copyright (c) 2022–2023 David Love

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""
Examples of the module use, both as simple applications and as helper classes
for reuse in more complete applications

Overview
--------

This is a collection of examples, utility classes and other scraps of code which
demonstrate the use of the library in common applications. Many of these
examples will require extension, or further development in real applications.
However they should give some idea of what those more complete applications may
look like.

Tested Implementations
----------------------

This version is written for MicroPython 3.4, and has been tested on:

  * Raspberry Pi Pico W

Licence
-------

This module, and all included code, is made available under the terms of the MIT Licence

> Copyright 2021--2022 (c) Erik de Lange, Copyright (c) 2022--2023 David Love

> Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

> The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""

Sub-modules

urest.examples.echo

An example of a 'noun' class which echo's responses to the client …

urest.examples.led_control

An example of a small application which control a single GPIO pin …

urest.examples.pwmled

An example of a 'noun' class, able to serve as the basis for PWM control of an LED attached to a suitable GPIO pin …

urest.examples.simpleled

An example of a 'noun' class, able to serve as the basis for control of an LED attached to a GPIO pin …