Python SmartMeshSDK

About SmartMeshSDK

The SmartMesh SDK is a Python package which simplifies the integration of a SmartMesh IP or a SmartMesh WirelessHART network into your application. It implements the Application Programming Interface (API) of the device it is connected to. A set of sample applications are included in the SmartMesh SDK, allowing a programmer to quickly understand the API and use it as part of a larger system.

SmartMeshSDK Features

  • Complete API definitions. Supports the full API of the SmartMesh IP Manager, SmartMesh IP Mote, SmartMesh WirelessHART Manager, and SmartMesh WirelessHART Mote. No need to copy-paste command definitions.
  • Low-level connectors. Enables your application to connect to all Dust Networks devices, over all transport media, including serial, XML-RPC and SerialMux. No need to develop low-level modules.
  • dustUI visuals library. A set of standard GUI elements with a common look-and-feel which can easily be customized.
  • Full source code. Delve into the inner-workings of the SmartMeshSDK.
  • Example applications. Both GUI based, and script based. Provided in source code and binary formats.
  • Fully documented. High level hands-on introduction guide, as well as Doxygen-based source code documentation.
  • Portable. Does not require anything beyond a standard Python installation. Runs on any platform which supports Python, including Microsoft Windows, Linux and MacOS.
  • Extensible. Is designed to be integrated inside a larger application.


Where should I download the SmartMesh SDK from?

In summary, you have two choices:

Both options contains the same version of the SmartMesh SDK.

More explanation:

  • The Python SmartMesh SDK repository has the following directory structure:
    • src/ contains the same source code as you can find on GitHub (see below)
    • win/ contains a compiled Windows executable for each sample application, built using the py2exe utility, allowing you to run the sample application on a Windows computer without having to install Python.
    • doc/ contains the documentation extracted from source code by using the Doxygen utility.
    • api/ contains some example C code for basic operations like HDLC framing.
  • https://github.com/dustcloud/smartmeshsdk contains the same source code as above, but without the pre-built documentation and executables.
  • https://github.com/dustcloud/smartmeshsdk/releases contains the latest builds of the compiled Windows executable for each sample application


Once you have the SmartMesh SDK downloaded, see the Getting Started section for further instructions. 

Documentation

This site contains more details about how to get started and the applications that are included in the SmartMesh SDK. 

External documentation

In addition, the SmartMesh SDK is documented in the following documents:


Documentation

Questions

Issues

Source code