protoserver.app module

class protoserver.app.CommandMessageForm(*args, **kwargs)

Bases: FlaskForm

FlaskForm for creating a Command Message.

Variables:

• message_id (StringField) – Unique identifier for the message.

• correlation_id (StringField) – Identifier for correlating messages.

• vehicle_id (StringField) – Identifier for the associated vehicle.

• type (SelectField) – Type of the message (e.g., command).

• priority (StringField) – Priority level of the message.

• provisioning_state (SelectField) – Provisioning state of the message.

• version (StringField) – Version of the message.

• packet_status (SelectField) – Status of the packet (e.g., Live).

• subtype (SelectField) – Subtype of the command message.

For Future Changes

This form assumes that the fields message_id, correlation_id, vehicle_id, type, priority, provisioning_state, version, packet_status, and subtype are present in future proto versions of CommandMessage as in version TMCVP 6.3. If any of these headers change, the code needs to be modified.

protoserver.app.get_additional_fields()

A function to handle the /get_additional_fields route and return additional fields HTML based on the request data.

This function is called on subtype dropdown change

$('#{{ form.subtype.id }}').change( function() {
var selectedSubtype = $(this).val();
var numEntries = $('#{{ form.numEntries.id }}').val();

$.ajax({
    url: '/get_additional_fields',
    method: 'POST',
    headers: {
        'X-CSRFToken': csrf_token
        },
    data: { 'subtype': selectedSubtype, 'numEntries': numEntries },
    success: function (response) {
        $('#additionalFieldsContainer').html(response.additional_fields_html);
        }
    });
})

protoserver.app.send_command()

Generate and send a command message based on the form data.

This function extracts the subtype from the form data and generates a command message using the generate_command_message() function. The generated message is then serialized and published to the appropriate MQTT topic.

Returns:

JSON object containing the response with status, command message as a dictionary, and the hex representation of the serialized message.

Return type:

(str)

protoserver.app.generateDynamicForm(payload)

Generate a dynamic form class based on the given payload.

Works almost same as utils.fill_message().

Parameters:

payload (google.protobuf.message.Message) – The message fields lled into the form.

Returns:

The generated form class.

Return type:

DynamicForm (FlaskForm)

protoserver.app.generate_command_message(subtype, form)

Generate a Command Message based on the provided subtype and form input.

This function uses google.protobuf.json_format.ParseDict() for parsing the form data, as request.form is an ImmutableMultiDict object.

Parameters:

• subtype (int) – The subtype of the command message corresponding to enum commandMessageSubType

• form (dict) – A dictionary containing the form data from the request

Returns:

The generated CommandMessage.

Return type:

tmcvp_command_message_pb2.CommandMessage

Works almost same as commander.generate_command_message().

protoserver.app.fill_payload(message, form)

Fills the payload message with data from the form.

Literally the same as utils.fill_message()

Warning

Use google.protobuf.json_format.ParseDict() instead.

protoserver.app.handle_mytopic(client, userdata, message)

Callback function for handling MQTT messages on a specific topic.

This function decodes the payload of the received MQTT message based on the topic and emits the decoded information to the connected clients through Socket.IO.

If the decoding fails, a warning message is emitted, and the payload is marked as “Parsing Failed” in the Socket.IO message.

The corresponding socket.io event is “mqtt_message” which is handled as

const socket = io.connect('http://' + document.domain + ':' + location.port);
socket.on('mqtt_message', function(data) {
    showToast({
        header: 'MQTT Response received on',
        data: data.topic
    });
    $('#responseHex').html(data.messageHex);
    $('#response').html(data.message);
});

protoserver.app.decode_response(rcvdMsg)

Decode command response received in the MQTT message.

Parameters:

rcvdMsg (bytes) – The received MQTT message in bytes.

This is equivalent to protoserver.commander.decode_response()

Caution

This function assumes that the fields message_id, correlation_id, vehicle_id, type, subtype, priority, provisioning_state, version, time_stamp, packet_status and return_code are present in future proto versions of CommandResponseMessage as in version TMCVP 6.3. If any of these fields change, the code needs to be modified. However, it is agnostic to changes commandResponsePayload.

protoserver.app.decode_telemetry(topic, rcvdMsg)

Decodes different types of telemetry messages received in MQTT Protobuf.

Parameters:

• topic (str) – The topic of the received MQTT message.

• rcvdMsg (bytes) – The received MQTT message in bytes.

Returns:

A table representation of the telemetry message.

Return type:

(str)

protoserver.app.decode_vehicleevents(rcvdMsg)

Decodes different types of vehicle events messages received in MQTT Protobuf.

Parameters:

rcvdMsg (bytes) – The received MQTT message in bytes.

Returns:

A table representation of the vehicle events message.

Return type:

(str)

Example:

def decode_vehicleevents(rcvdMsg):
    vehicle_event_message = tmcvp_vehicleevent_message_pb2.VehicleEventMessage()
    vehicle_event_message.ParseFromString(rcvdMsg)
    print(utils.MessageToTable(vehicle_event_message))

rcvdMsg = b"\n$2404c70e-41a6-4908-97d9-2e3c33073db7\x12\x02NA\x1a\x11ACCDEV14012076255 \x04(\x142\x0118\x02B\x056.3.0J\x08\x08\x98\xb6\xe3\xb0\x06\x106PLZ'\xaa\x01$\x08\x80\xa4\xa7\xda\x06\x10\x80\xa4\xa7\xda\x06\x18\xf7\xc1\xd7/ \xa0\xa7\xe5\x15(\x012\x08\x08\x98\xb6\xe3\xb0\x06\x10h8\x01"
decode_vehicleevents(rcvdMsg)

protoserver.app.TmcvpMQTTProtobufServer()

This function is for wsgi server that runs the app

Examples

Using Gunicorn

$ gunicorn -w 4 -b 0.0.0.0 'protoserver.app:TmcvpMQTTProtobufServer()'
# or
$ gunicorn -w 4 -b 0.0.0.0 tmcvp-server

Using Waitress

$ waitress-serve --call protoserver.app:TmcvpMQTTProtobufServer
# or equivalently
$ waitress-serve --call tmcvp-server

Returns:

Flask application object

Return type:

app (flask.Flask)