Giter VIP home page Giter VIP logo

pyudmi's Introduction

UDMI Python helpers

Intro

This is a set of classes to help when working with UDMI. See https://github.com/faucetsdn/udmi/blob/master/README.md

There are currently seven classes representing the corresponding UDMI types:

  • Config
  • Discover
  • MetaData
  • Pointset
  • Properties
  • State

They are available at the top level of this module. ie udmi.Pointset

So far the subtypes used in UDMI such as config_pointest are not representated by classes and remain dicts

They do three useful things currently:

Validation

They perform data validation against the published version 1 UDMI json schemas on creation, throwing an exception if the input data is malformed.

Serialisation

Uniform serialisation to the udmi json format from object orientated interface.

Timestamps

There's a method that serialises timestamps given in python datetime format correctly.

Installation

pip install pyudmi

Usage

You can create these objects in two ways. Each class has a normal Python constructor to make programatic creation easier eg:

import udmi

config = udmi.Config(timestamp, system, pointset, gateway)

And a class method common to them all:

config = udmi.Config.from_string(udmi_string)

To serialise as a udmi json string use the method as_udmi

udmi_string = config.as_udmi()

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.