Categorygithub.com/xmidt-org/interpreter
modulepackage
0.0.7
Repository: https://github.com/xmidt-org/interpreter.git
Documentation: pkg.go.dev

# README

interpreter

Interpreter validates events and can be used in projects that aim to generate aggregate or individual device metrics.

Build Status codecov.io Go Report Card Apache V2 License Quality Gate Status GitHub release PkgGoDev

Summary

Interpreter provides different validations for validating:

  • Events are valid (e.g. having a proper boot-time, etc.)
  • Boot-cycles are as expected.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Install

go get -u github.com/xmidt-org/interpreter

Contributing

Refer to CONTRIBUTING.md.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewEvent creates an Event from a wrp.Message and also parses the Birthdate from the message payload.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

DeviceIDRegex is used to parse a device id from anywhere.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventRegex is the regex that an event's destination must match in order to parse the device id properly.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Event is the struct that contains the wrp.Message fields along with the birthdate that is parsed from the payload.