Webportal v1

embedded apps

    Connectivity - Message

    Edit

    SEND MESSAGE TO SERVER #

    WHAT YOU NEED

    SENDING A MESSAGE #

    The Application generates a message that is encapsulated inside the content field then sent to the WebPortal before being forwarded to the Application server through the Stellantis Messaging System.

    To send a message you can do the following:

    1
2
3
4

    window.parent.postMessage({
    'type' : 'WebPortal.onSendNotificationRequest',
    'value' : yourDataPayload
}, '*');

    Note: the max size for a MQTT message is 128 Kio

    SEND MESSAGE TO APP #

    WHAT YOU NEED

    SENDING AN APPLICATIVE MESSAGE #

    The Applicative message lets you send data to your application.

    STRUCTURE OF MQTT MESSAGE # 

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

    {
	/**
	 * Your application identifier (provided by Stellantis)
	 * @type {string}
	 */
	"idApp": "yourAppIdentifier",

	/**
	 * Flag to allow the WebPortal to recognize the message type
	 * @type {boolean}
	 */
	"popup": false,

	/**
	 * Arbitrary data for your application
	 * @type {object}
	 */
	"content": {
		"type": "action",
		"action": "doSomething",
		"params": {
			"arg1": 42,
			"arg2": "a string",
			"arg3": [1, 2, 3, 4],
			"arg4": {"firstname": "John", "lastname": "Doe"}
		}
	}
}

    HANDLING MESSAGE # 

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

    var targetVin = "0123456789ABCDEFG";
var mqttPublishTopic = `psa/OVIPPartners-Dev/from/uid/${mqttConfig.username}/opa/${targetVin}`;
var payload = {
	"idApp": "MY_APP_ID",
	"popup": false,
	"content": {
		"type": "action",
		"action": "doSomething",
		"params": {
			"arg1": 42,
			"arg2": "a string",
			"arg3": [1, 2, 3, 4],
			"arg4": {"firstname": "John", "lastname": "Doe"}
		}
	}
};

var mqttMessage = new MQTTMessage();
mqttMessage.payload = JSON.stringify(payload);
mqttMessage.qos = 0;

mqttClient.publish(mqttPublishTopic, mqttMessage);

    Note: The QOS 0, QOS 1 and QOS 2 connections will all be downgraded to QOS 0. This means that if acknowledgment of a message is needed then this functionality must be implemented directly by the application.

    Note: the max size for a MQTT message is 128 Kio

    RECEIVING MESSAGE #

    WHAT YOU NEED

    RECEIVING AN APPLICATIVE MESSAGE #

    The Application generates a message that is encapsulated inside the content field then sent to the Application server through the Stellantis Messaging System.

    STRUCTURE OF MQTT MESSAGE # 

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

    {
	/**
	 * Arbitrary data from your application
	 * @type {object|string}
	 */
	"content": {
		"type": "action",
		"action": "doSomething",
		"params": {
			"arg1": 42,
			"arg2": "a string",
			"arg3": [1, 2, 3, 4],
			"arg4": {"firstname": "John", "lastname": "Doe"}
		}
	}
}

    HANDLING MESSAGES # 

    1
2
3
4
5
6
7

    const mqttSubscribeTopic = `psa/OVIPPartners-Dev/to/uid/${mqttConfig.username}/opa/#`;
mqttClient.subscribe(mqttSubscribeTopic);

mqttClient.onMessage(function(topic, payload) {
	const myAppMessage = JSON.parse(payload).content;
	MyAppDomain.processMessage(myAppMessage);
});

    Note: the max size for a MQTT message is 128 Kio