Giter VIP home page Giter VIP logo

eclipsefdn / sparkplug.eclipse.org Goto Github PK

View Code? Open in Web Editor NEW
0.0 10.0 10.0 14.01 MB

The Eclipse Sparkplug Working Group seeks to drive the evolution and broad adoption of the Eclipse Sparkplug protocol and related technologies that enable the creation of open, collaborative, and interoperable Industrial IoT (IIoT) solutions.

Home Page: https://sparkplug.eclipse.org

License: Eclipse Public License 2.0

HTML 56.73% JavaScript 5.97% Less 31.11% Shell 2.43% Mustache 3.07% Jsonnet 0.69%
webdev hugo

sparkplug.eclipse.org's Introduction

sparkplug.eclipse.org


NOTE

This project was migrated to Eclipse Gitlab on March 25, 2022.


The https://sparkplug.eclipse.org website is generated with Hugo. This project is a work in progress.

The Eclipse Sparkplug Working Group seeks to drive the evolution and adoption of the Eclipse Sparkplug protocol and related MQTT-based technologies that enable the creation of open, collaborative, interoperable, and scalable Industrial IoT (IIoT) solutions and provide support for Industry 4.0.

Getting started

Install dependencies, build assets and start a webserver:

yarn && hugo server

You can find guidance on the page-level metadata here, and examples of the assorted page types (components) here.

Contributing

  1. Fork the eclipsefdn/sparkplug.eclipse.org repository
  2. Clone repository: git clone https://github.com/[your_github_username]/sparkplug.eclipse.org.git
  3. Create your feature branch: git checkout -b my-new-feature
  4. Commit your changes: git commit -m 'Add some feature' -s
  5. Push feature branch: git push origin my-new-feature
  6. Submit a pull request

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

Related projects

Images, less and JavaScript files for the Eclipse Foundation look and feel.

Hugo theme of the Eclipse Foundation look and feel.

Bugs and feature requests

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Author

Christopher Guindon (Eclipse Foundation)

Trademarks

  • Jakarta and Jakarta EE are Trademarks of the Eclipse Foundation, Inc.
  • Eclipse® is a Trademark of the Eclipse Foundation, Inc.
  • Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

Copyright and license

Copyright 2019 the Eclipse Foundation, Inc. and the sparkplug.eclipse.org authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).

sparkplug.eclipse.org's People

Contributors

autumnfound avatar chrisguindon avatar ericpoirier avatar fdesbiens avatar flora8984461 avatar fredg02 avatar linkfang avatar mbarbero avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

sparkplug.eclipse.org's Issues

Add a "Join Us" page

We missed one of the requirements for the new version of the Sparkplug website. The steering committee expected the "Join Us" button would lead to a dedicated page.

The request is to add the page to the website. The copy for this new page can be found below.

=====
You can join the Sparkplug ecosystem in many different ways. The goal of this page is to explain you how.

Maintain and evolve the Sparkplug the specification

Read the Sparkplug specification

The lastest published version of the specification is available here.

If you are interested in the cutting edge, you can have a look at the GitHub repository for the specification. Anyone can propose changes to the specification by submitting pull requests.

Join the Sparkplug specification project

You can become a contributor to the project by submitting a pull request. The process is explained on the home page for the repository.

If you make a number of contributions over time, the project team may invite you to join them and become a committer on the project. It is not necessary for your organization to be a member of the Eclipse Foundation or the Sparkplug working group in order for you to become a committer.

Download an open source Sparkplug implementation

Eclipse Tahu is an open source commercial grade and production quality implementation of the Sparkplug specification. It is developed in sync with the specification itself.

Join the Sparkplug Working Group

The Sparkplug working group is a group of like-minded companies and organizations that are driving the creation and stewardship of the Sparkplug specification and strengthening awareness and adoption through an open branding and compatibility program.

Please have a look at our membership prospectus to learn about the benefits of a Sparkplug membership.

The working group offers a mailing list and Slack workspace where members and non-members can exchange and collaborate.

Sparkplug Working Group Mailing List

You can join the mailing list by following this link. Please note a free Eclipse Foundation account is required to subscribe.

Sparkplug Slack Workspace

[Click this link](Join me on Slack — it’s a faster, simpler way to work. Sign up here, from any device: https://join.slack.com/t/eclipse-sparkplug-wg/shared_invite/zt-btcn48au-luMXPXMbMhBzS4pCaLO6_w) to join the working group's Slack workspace. Many key Sparkplug contributors can be found there on a regular basis.

Add white paper to sparkplug resources page

tittle: Intel & ExxonMobil joint public whitepaper on “Transform the Automation & Control of Onshore Oil &Gas Wells and Surface Facilities”.

White paper link : https://www.intel.com/content/www/us/en/energy/resources/exxonmobil-transform-whitepaper.html

Desc: The Universal Wellpad Controller (UWC), developed in collaboration with ExxonMobil, Leverages Off-The-Shelf (OTS) hardware and opensource to provide an innovative solution that brings cost-effective, interoperable automation and control to onshore O&G operations.

pls add the above to the sparkplug resources page:
https://sparkplug.eclipse.org/resources/

Add video to the resources page

Video link: https://www.youtube.com/watch?v=NKPb0FsM9bg
Tittle: Sparkplug: The Next Phase of Evolution For Industrial Automation | Virtual IoT Meetup
Desc: Digital transformation is changing the face of industrial automation. The proprietary, homogeneous and rigid architectures of yesterday are supplanted by ones that are open, heterogeneous and flexible. MQTT accelerated this transition 20 years ago. Sparkplug is now ready to do the same by making MQTT infrastructure interoperable out of the box. In this webinar, you will discover how Sparkplug can bring your digital transformation projects to the next level through three case studies.

The "View All Events" link is broken

Capture d’écran 2021-06-15 103738

The "View All Events" link on the Sparkplug home page leads to a 404 page.

@chrisguindon I wonder if this is linked to the fact we are missing a "View More News" button as well. Filling a separate issue for that one.

Thank you in advance for fixing this!

Please add the Sparkplug webinar on sparkplug.eclipse.org

Hi everyone

Please add the Sparkplug webinar video on sparkplug.eclipse.org

We can create an (additional third) button titled "Watch our Sparkplug MQTT Webinar" in the header section and upload the YouTube video --> https://www.youtube.com/watch?v=PYYlEktoO-c&list=PLy7t4z5SYNaS3WoylJsNuox2f3t2gpQfK&index=1

When we have the new website with a resources section implemented, we would import the video on the new website as well.

@fdesbiens It would be great if you can share your input on this as well.

Thanks!
Ioana

Add video to resources page of sparkplug

Video link: https://www.youtube.com/watch?v=qhLYz0sITlw&t=22s
tittle: Sparkplug Essentials 05 - Sparkplug Components
Desc: In this video, we introduce you to the five infrastructure components of Sparkplug:

  1. SCADA / IIoT Host
  2. Edge of Network (EoN) Nodes
  3. Devices / Sensors
  4. MQTT Application Nodes
  5. MQTT Broker

In detail:

  1. SCADA / IIoT Host
    It is also called Primary Application. The SCADA/IIoT Host is responsible for the supervision, monitoring, and control of all other components. It also provides state awareness for all participants in the deployment. Whenever a device or sensor becomes unavailable, the SCADA/IIoT Host will get this information. Unlike in a traditional system, the SCADA / IIoT Host is not connected to other components directly, but to the central MQTT broker.

  2. Edge of Network (EoN) Nodes
    Edge of Network Nodes are sometimes also called gateways. Their function is to bridge devices and sensors, that are connected via protocols like OPC-UA, Modbus, or proprietary PLC vendor protocols, and cannot connect to the Sparkplug infrastructure directly. EoN Nodes also manage the state of connected sensors and devices.

  3. Devices / Sensors
    This is basically the industrial infrastructure on any manufacturing shop floor. Physical devices and sensors, that traditionally use a poll/response protocols for connectivity. EoN Nodes are used to bridge all the different communication protocols to Sparkplug and its typical MQTT publish/subscribe pattern.

  4. MQTT Application Nodes
    Also known as Secondary Applications these are software systems like Manufacturing Executions Systems (MES), Historians, Analytics or even customized Applications, developed for individual use cases. MQTT Application Nodes usually consume data, but also send data back into the system.

  5. MQTT Broker
    This is the central data distribution component and is compulsory for every Sparkplug infrastructure. All EoN Nodes, MQTT Application Nodes, SCADA / IIoT Hosts, and Sparkplug enabled devices are connected to the MQTT broker. Usually, the MQTT broker is kept close to the devices. But for some deployments it can also be useful to establish a cloud-based MQTT broker. A free MQTT broker is for example HiveMQ Cloud, and there are also open-source brokers like HiveMQ CE, or Mosquitto available. For production environments, HiveMQ is recommended, since among other factors high availability and a proper permission system are key for business-critical use cases. Make sure to use a 100% MQTT compliant broker. Cloud brokers like AWS IoT or Azure IoTHub will not work with Sparkplug, since they lack support of important MQTT features.

Add video to the resources page of sparkplug

Video link: https://www.youtube.com/watch?v=PPpdOUYolIY
Tittle: Sparkplug Essentials 04 - Sparkplug Key Principles
Desc: In this video, we introduce you to the eight key principles for MQTT Sparkplug:

  1. Publish / Subscribe Architecture
  2. Report by Exception
  3. Continuous Session Awareness
  4. Death and Birth Certificates
  5. Persistent Connections
  6. Auto Discovery
  7. Standardized Payload Definition
  8. Standardized Topic Namespace

*** The Key Principles in Detail ***

  1. Publish / Subscribe Architecture
    This displaces the old poll-response pattern, which had certain disadvantages. The modern decoupled publish-subscribe approach enables features like instant messaging and one-to-many communication

  2. Report by Exception
    Also based on a modern publish-subscribe pattern, Report-By-Exception saves a significant amount of bandwidth and computing power compared to the old poll-response pattern. The communication is also faster and more reliable since it uses push communication and does not need to wait for the next pull-response cycle when data or a device state changes.

  3. Continuous Session Awareness
    This is an important monitoring feature for online/offline states of devices. It provides a correct real-time view of the state of all devices, gateways, and applications in your deployment.

  4. Death and Birth Certificates
    This feature is used for the management and discovery of device states. As soon as an MQTT client goes online, it is required to send out a birth certificate. When it goes offline, the MQTT broker recognizes the changed state and informs every subscribed client by sending a death certificate.

  5. Persistent Connections
    All devices, gateways, and applications in a deployment use persistent TCP connections

  6. Auto Discovery
    Sparkplug provides Plug & Play interoperability. This is ensured by auto-discovery of device states, and what data will get sent.

  7. Standardized Payload Definition
    Defining a standard data format for all messages guarantees faultless communication between all participants.

  8. Standardized Topic Namespace
    This is also a requirement for Plug & Play interoperability. A common topic namespace used by all Sparkplug participants.

Add a "View More News" Link to the Sparkplug home page

There is a list of recent news at the bottom of the Sparkplug home page. It displays the three most recent new items. However, the list is lacking a "View More News" button like the one found on iot.eclipse.org.

Capture d’écran 2021-06-15 104152

@chrisguindon I wonder if this is linked to issue #89.

Thanks for your assistance!

Add Part 2 video to the sparkplug resources page.

link to video: https://www.youtube.com/watch?v=27_DKWjE3gg

link to page:https://sparkplug.eclipse.org/resources/

Title: Sparkplug Essentials 02 - Requirements for MQTT Sparkplug

Desc: What are the requirements for Sparkplug?

Sparkplug relies heavily on MQTT. In order to use Sparkplug it is important to use an MQTT broker that fully supports the MQTT 3.1.1 specification. It is not possible to use Sparkplug unless MQTT broker and clients support at least MQTT version 3.1.1 or higher.

The hard requirements for Sparkplug are

• QoS 0 and 1
• Retained Messages
• Last Will and Testament
• A flexible security system

Quality of Service 1 (delivery at most once) and Quality of Service 1 (delivery at least once) are mandatory for using Sparkplug. For more information about Quality of Service Levels read our blog post
https://www.hivemq.com/blog/mqtt-esse...
or watch the video on the same topic:
https://www.youtube.com/watch?v=hvhtJ...

Retained Messages and Last Will and Testament are also required features for MQTT Sparkplug. Make sure your MQTT broker offers 100% MQTT 3.1.1 conformity. For a better understanding of Retained Messages and Last Will and Testament we recommend reading our blog posts:

https://www.hivemq.com/blog/mqtt-esse...
https://www.hivemq.com/blog/mqtt-esse...

Tweaks to the members section of the website

Hi team.

I would like the following changes be made to the "members" section, please.

  • Change the header from "Founding Members" to "Members"
  • Remove ORing's logo (and remove their testimonial)
  • Add Intel, SignalFire Telemetry and the University of Sheffield

@chrisguindon All of them provided their logos when they joined but let me know if you need assistance in securing some of those.

Thanks!

Add Mike's blog to news

Please add Mike's blog to news on sparkplug.eclipse.org

Title: The 2020 IoT Developer Survey Goes to the Edge
Author: Mike Milinkovich
Date: Monday, May 11, 2020 - 08:30
Summary: Our 2020 IoT Developer Survey is open until June 26, and for the first time, the survey includes questions about how developers are incorporating edge computing technologies into their IoT solutions.

Link: https://blogs.eclipse.org/post/mike-milinkovich/2020-iot-developer-survey-goes-edge

Please let me know if there's anything else you need

Issues with the events list

All events currently on the Sparkplug home page are in the past. Yet, they are still displayed.

  1. Why did they not vanish? Is there an issue with the expiration logic?

  2. All URLs in these events point back to the sparkplug home page, not to the correct websites. Not sure if that is due to the previous point.

Thank you for your assistance!

Please add the Sparkplug Membership Prospectus to sparkplug.eclipse.org/

Hi everyone,

Please add the Sparkplug Membership Prospectus on sparkplug.eclipse.org/.

  1. Go to sparkplug.eclipse.org/
  2. Go to the "Join" section
  3. Replace the title "Contact us about your organization joining the Eclipse Foundation" with "Contact us about your organization joining the Sparkplug Working Group"
  4. On the left side of the "Join" page, replace the old content with the content attached in the document: "Landing page “Sparkplug Membership Prospectus” "
  5. Attach the sparkplug membership prospectus for download.

Thank you!
Ioana

Landing page “Sparkplug Membership Prospectus”-Draft.docx

Sparkplug Membership Prospectus.pdf

Create initial look and feel for sparkplug.eclipse.org

The initial website will have 2 pages, the homepage and a FAQ page.

Homepage content/section:

  • Jumbotron
  • News and Events
  • Mission Statement
  • Our Founding Members
  • Testimonials
  • FAQ teaser
  • Featured footer for promoting mailing list.

Typography

  • @font-family-sans-serif: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;

Color pallette:

  • @brand-primary: #396894; // Blue

  • @brand-secondary: #5997BD; // Light Blue

  • @brand-tertiary: #213970; // Dark Blue

  • @brand-quaternary: #efefef; // Light Gray

  • @brand-quinary: @brand-quaternary; // Light Gray (Breadcrumbs)

  • @brand-info: @brand-tertiary;

  • @brand-info-light: lighten(@brand-info, 20%);

  • @brand-warning: @brand-primary;

  • @brand-gradient: linear-gradient(-77deg, rgba(250,174,68,1) 0%, rgba(237,42,40,1) 50%, rgba(124,72,155,1) 100%);

  • @brand-gradient-color: #faae44;

Branding

  • SVG Logo:
  • Social media image:
  • Favicon:

Image is a little bit distorted on IE11

Describe the bug
Image is a little bit distorted on IE11

Screenshots
image

Desktop (please complete the following information):

  • OS: [e.g. iOS] WIN10
  • Browser [e.g. chrome, safari] IE11

Add the video to the resources page of sparkplug

link to video:https://www.youtube.com/watch?v=4lunu8XBZqo
tittle: Sparkplug Essentials 01 - Introduction to MQTT Sparkplug
Desc: In this video series, we will introduce the industry-standard protocol MQTT Sparkplug. We will explain why it is different from other communication protocols, and how companies benefit from Sparkplug in their Industrial IoT use cases, making it one of the biggest trends in connectivity.

Header Quotations

Header quotation is currently rotating. This quotation should be fixed and use Arlen's headshot and quote.

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.