The SME Connect documentation is divided into two main sections:
-
SME Connect Basics: This section describes a broader overview of SME Connect
application with illustrative examples of important user processes such as logging into SME Connect or joining a room.
-
API Services: This section provides links to each API service
and important packages for development. There are eight main services that make up SME Connect to handle the application's different
functionalities such as creating WebRTC connections, registering users, and authenticating tokens.
SME Connect Basics
To learn the basics of SME Connect and important concepts/terminology,
view the getting started guide.
Tools Gateway
The Tools Gateway, also known as the EmbeddedNode, allows users to connect USB-enabled tools, such as a digital multimeter or an external camera to SME Connect.
The Tools Gateway supports tools such as digital cameras, digital micrometers, digital multimeters, and optical borescope. For backend APIs, the Tools Gateway and its connected tools are each considered individual users, with the tools having a direct connection with a Tools Gateway (known as “EmNode” or “Embedded Node”).
API Services
This section provides detailed reference documentation for the APIs used in SME Connect. For an introduction to SME Connect and its main processes,
please visit the SME Connect Basics section.
The APIs can be divided into three main subsections:
- Authentication and Authorization Services
-
Authn: Authenticates a JSON web token (JWT) from multiple sources
and authorizes a user to log into other SME Connect services
-
Client Auth: Authenticates the Tools Gateway & CAC login method
-
OAuth: Performs 3rd-party authentication validation
- User and Room Services
-
Presence: Managers user, room, and tool data
-
Signal: Handles WebRTC Connections
-
Asset Manager: Manages assets including PDFs, images, and CAD files
- Debugging Services
-
Graylog: Logs data and processes for debugging