Teams Flux Asset

Introduction

Microsoft Teams is a communication and collaboration platform developed by Microsoft as part of the Microsoft 365 suite. It provides a centralized workspace for teams to chat, conduct video meetings, share files, and collaborate on projects in real-time. Integrated with other Microsoft services like SharePoint, OneDrive, and Outlook, Teams allows users to seamlessly manage tasks, access documents, and work together regardless of their physical location. It's widely used for both business and educational environments to enhance productivity and streamline teamwork.

TeamsMQTT allows you to receive and display MQTT payloads, through Teams channels and chats. This asset allows an easy integration between thr Broker and the Teams teams, offering useful functionalities to display your data directly from Teams. Its versatility allows this asset to be hihgly personalized, designed to meet your business requirements and needs, all from a familiar interface.

Features and Benefits

Seamless Communication: Enables seamless integration between Slack workspaces and MQTT clients, streamlining the exchange of data across platforms;
Real-Time Monitoring: Facilitates real-time data exchange between Slack and the broker, through Slack messages;
Easy Integration: Simplifies the integration of Slack with your IoT projects, making it possible to receive data from various IoT devices;

Prerequisites

Before you install and configure the asset, make sure you have the following prerequisites:

Basic understanding of the MQTT Protocol;
Global administrative permissions in the organization's Microsoft ;
Access to an MQTT broker compatible with your setup;
MQTT Client software (such as MQTT Explorer or similar);
Access to a Teams team.

Microsoft Azure - Application

Asset Instalation

Using Coreflux HUB

Please refer to the general docs for asset installation through the Coreflux HUB.

Using Coreflux HUBLESS

Asset management and control are conducted using the MQTT protocol. Commands (payload) are sent to the $/Coreflux/Command topic. The results of these commands are published to $/Coreflux/Command/Output. The following steps will focus solely on the payload that needs to be sent.

Connect to the Coreflux MQTT Broker using your preferred client;
Login using your Coreflux Account:
```
-L myname@mydomain.com password
```
Check for available assets:
```
-l
```
Install the asset:
```
-I coreflux_teamsmqtt
```
If there were no issues during the installation, you should receive a message on the $/Coreflux/Command/Output:

Your coreflux_teamsmqtt was installed with the version <version> with the <asset_guid>. Let the magic begin!

Asset Configuration

Before using the asset, it must be properly configured.
This configuration process entials adjusting various parameters that affect its functionality, the setup of the device, and how they interact with each other.
This involves specifying the device's IP address, selecting which symbols to read from the device, among other settings.

The configuration is detailed in a JSON file, divided into three main sections: MQTT Parameters, Teams parameters and Tags.
The instructions below serve as a configuration guide, for each section. By the end, you should have a comprehensive example configuration that can be tailored to your specific needs.

⚠ : If a parameter is not included in the asset's configuration and it is not required, a default value will be applied. Incorrect configuration may cause the asset to not work as intended.

ℹ : This configuration is presented using a hubless setup as an example. The key takeaway is the understanding of the parameters and their significance. If you are configuring the asset via Coreflux Hub, the same parameters and configurations apply.

MQTT Parameters

The MQTTParameters in the JSON configuration define how to connect to a MQTT Broker, specifying the communication details.

The Address and Port indicate the broker's network location (in this case, 127.0.0.1 on port 1883), which is where the data will be sent to or received from.
The parameters also detail authentication methods and use of TLS for secure communication.

This setup determines the pathway for the data exchange between the device and the MQTT broker, facilitating the monitoring or control of device operations.

Parameter	Description	Required	Example	Default Value
Port	Port number on which the MQTT broker is running.	Yes	`1883`	`1883`
Address	IP address or hostname of the MQTT broker.	Yes	`"iot.coreflux.cloud"`	`"127.0.0.1"`
IsAnonymous	Indicates if the connection is anonymous (no username/password required).	No	`true`	`true`
Username	Username for authentication, if not anonymous.	No	`""` (empty string)	`""` (empty string)
Password	Password for authentication, if not anonymous.	No	`""` (empty string)	`""` (empty string)
WithTLS	Specifies whether TLS encryption is enabled for secure communication.	No	`true`	`false`
ClientId	Used to uniquely to identify the client to the MQTT broker.	Yes	`Client1`	`Random.Name.Generator`

Example:

{
    "MqttParameters": {
        "Port" : 1883,
        "Address" : "iot.coreflux.cloud",
        "IsAnonymous" : true,
        "UserName" : "",
        "Password" : "",
        "WithTLS" : false,
        "ClientId" : "ClientId1"
    }
}