Status

Date

Doc Version

Confidentiality

RELEASED

v1.1

PUBLIC

Introduction

Welcome to Wirepas Developer Portal. In this getting started you will understand how Wirepas deliverables are organized, where to find what and how to get support.

What you’ll learn

  • How to access Wirepas deliverables
  • What is where and how things are organized
  • What is the support flow and how to get support

What you’ll need

  • A Wirepas Developer Portal account 
  • Optionally a Wirepas Sharefile account depending on your Wirepas License received from Wirepas

Wirepas Developer tools

Wirepas deliverables are accessible from 3 different tools:

  • Wirepas Developer Portal: The main entry point to Wirepas technology: Knowledge base, tools and support
  • Wirepas GitHub: Where all open source components are available
  • Wirepas Sharefile: Where all binaries and tools under license are delivered

This document is intended to be used by Wirepas technology users. Depending on your User Category and access rights you may or may not access to some parts of the deliverables.

User Category

Description

Contractual framework between User Company and Wirepas

Self Registered 

User

Customer willing to discover Wirepas technology

No contract

Evaluation Kit

Customer willing to use Wirepas Evaluation Kits from existing customers/partners 

No contract

NDA

Customer willing to learn more about Wirepas technology

Non Disclosure Agreement (NDA)

Licensee

Customer willing to develop with Wirepas

Software License Agreement (SLA)

Wirepas Developer Portal

Introduction

The Developer Portal is the main entry point for a Wirepas developer and is accessible from the following address: https://developer.wirepas.com/

The developer portal requires a registration. The registration can be either a self registration for Self Registered Users or a registration after an invitation from Wirepas for other user categories.

Who can access?

All user categories can access and will have access to different services/deliverables depending on their respective User Category.

What is available?

The Developer Portal includes the following (depending on your User Category):

  • The Wirepas technical documentation library is fully available online and organized into categories
    • Getting Started: Contains all Getting Started documents for the different products.
    • System and Introduction: Overviews, Design Guides, Application Notes .
    • How to Guides: A complete library of unitary How Tos with step-by-step guides.
    • Wirepas Massive documentation: Release notes, Errata, APIs …
    • Wirepas Backend and Tools: Wirepas Network Tool, Backend installers, other tools.

Note: Each document has a Confidentially classification and can be either Public or Confidential under NDA, please make sure you follow those indications.

  • The ticketing system for technical support to create, update and monitor technical inquiries (not available for Self Registered Users) described in this section: Wirepas Developer Portal Ticketing
  • Access to some tools: e.g. Wirepas Network Tool Client installer, Wirepas Terminal tool …
  • Access to News and updates

The tool also provide a search engine to search in the Knowledge base, feel free to use it from the Developer Portal home page.

Wirepas GitHub

Wirepas GitHub contains all the open source components from Wirepas. It is publicly accessible from the following address: https://github.com/wirepas 

Who can access?

As an Open Source repository anybody can access without any registration. Anybody can also submit changes or improvements on the various deliverables.

What is available?

All Open Source components and tools.

To list a few we can highlight:

  • Wirepas Software Development Kit and applications: to develop a product based on Wirepas Massive Stack
  • Wirepas Gateway: Reference application for a Gateway
  • All Backend APIs: Gateway to Cloud, Wirepas Network Tool …
  • Tools and scripts: Wirepas MQTT Library, example scripts …

Wirepas Sharefile

Wirepas Sharefile contains all the licensee restricted deliverables. It also contains licensee specific files and allows to share files between Customer and Wirepas. Wirepas Sharefile is accessible from: https://wirepas.sharefile.eu/

Who can access?

Access is granted only to licensee users and only under invitation by Wirepas staff based on your license.

Note: Sharefile requires a dedicated account independent from Wirepas Developer Portal and provided by Wirepas only under invitation.

What is available?

  • All components provided under license as example:
    • Wirepas Stack binaries for the various chipsets
    • Keys for Backend installation
  • A per customer Shared folder is also provided to ease secured exchange of information between Customer and Wirepas.

How to get support

Wirepas provides support infrastructure to answer technical questions during the different phases of your development. The table below summarizes the type of support access available and from where for the different users:

User Category

Support access

From where / who can I get support?

Self Registered User

No access to Wirepas support

Wirepas Sales representative 

Evaluation Kit

Access for the duration of the evaluation 

Wirepas Developer Portal Ticketing

NDA

No access to Wirepas support

Wirepas Sales representative 

Licensee

Access with committed Service Level Agreement as part of the license

Wirepas Developer Portal Ticketing

Wirepas Developer Portal Ticketing

Assuming your User Category allows you to log tickets, Wirepas Developer portal provides a complete tools for ticketing system.

To create a ticket:

  • Go the the Developer Portal home page and click “New Support Ticket” 
  • Fill the different fields, if needed attach a file and click create

  • Once your ticket is created you can interact with Wirepas Support from the Tickets menu.

Ticket lifecycle

The figure below describes the standard support flow for Wirepas Support and the associated ticket status

Notes: 

  • Please note that Resolved tickets are automatically closed after 48 hours
  • You can add people in CC to a ticket to share information
  • Ticket visibility can be provided across your organization so that everybody in an organization can see tickets from one another. This feature can be enable to your organization upon a ticket created to Wirepas Support.

For each ticket you will be asked to give your feedback. Your feedback is very important for us to improve our support quality.

Summary

The table below summarizes the different User Categories, Tools access and Wirepas Support model.

User Category

Description

Tools access

Wirepas Support

Wirepas Developer Portal

Wirepas GitHub

Wirepas Sharefile

Self Registered User

Customer willing to discover Wirepas technology

Yes (limited)

Yes

No

Wirepas Sales representative 

Evaluation Kit

Customer willing to use Wirepas Evaluation Kits from existing customers/partners 

Yes (limited)

Yes

No

Wirepas Developer Portal Ticketing

NDA Customer 

Customer willing to learn more about Wirepas technology

Yes 

Yes

No

Wirepas Sales representative 

Licensee

Customer willing to develop with Wirepas

Yes

Yes

Yes

Wirepas Developer Portal Ticketing

Revision History

Date

Version

Notes

v1.0

Initial version

v1.1

Replaced reference to “Wirepas Mesh” by “Wirepas Massive”
 Added Legal Notice

Legal Notice

Use of this document is strictly subject to Wirepas’ Terms of Use and Legal Notice.

Copyright © 2021 Wirepas Oy