Edit Signal reader assignments via M2M - Revision history

Alkitjohan at 16:26, 19 December 2024

2024-12-19T16:26:47Z

← Older revision		Revision as of 16:26, 19 December 2024
Line 19:		Line 19:
	The same function via the GUI can be seen in screenshot "Upload A2L via portal".		The same function via the GUI can be seen in screenshot "Upload A2L via portal".

	A successful response looks like:[[File:Upload A2L file via m2m.png\|Upload A2L file via m2m\|~~frame~~]]<code>[</code>		A successful response looks like:[[File:Upload A2L file via m2m.png\|Upload A2L file via m2m\|thumb]]<code>[</code>

	<code> {</code>		<code> {</code>

Alkitjohan at 16:23, 19 December 2024

2024-12-19T16:23:26Z

← Older revision		Revision as of 16:23, 19 December 2024
Line 152:		Line 152:
	[[File:Select A2L for ECU via GUI.png\|thumb\|Select A2L for ECU via GUI]]		[[File:Select A2L for ECU via GUI.png\|thumb\|Select A2L for ECU via GUI]]
	This is the same step as when selecting an A2L file in "Select files for ECUs" when copying an A2L file based assignment via the portal GUI. See screenshot. If the association is not provided, the selected signals from the A2L file source will be removed from the assignment.		This is the same step as when selecting an A2L file in "Select files for ECUs" when copying an A2L file based assignment via the portal GUI. See screenshot. If the association is not provided, the selected signals from the A2L file source will be removed from the assignment.

			==== 7. List signal sources for assignment ====
			[[File:List signal sources of assignment.png\|thumb\|List signal sources of assignment]]
			With a fresh copy using the latest vehicle profile version of the original assignment we want to list the available signal sources of the assignment: https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html#resource_EditSignalReaderAssignmentService_getSignalSources_id_GET

			Now we are using the "Edit signal reader assignment" services and we provide the id of the assignment we want to list signal sources for.

			An example response looks like:

			<code>[</code>

			<code> {</code>

			<code> "type": "OBD_II"</code>

			<code> },</code>

			<code> {</code>

			<code> "type": "WICE"</code>

			<code> },</code>

			<code> {</code>

			<code> "type": "UD"</code>

			<code> },</code>

			<code> {</code>

			<code> "type": "A2L",</code>

			<code> "ecu-name": "ABC"</code>

			<code> },</code>

			<code> {</code>

			<code> "type": "PASSIVE_CAN",</code>

			<code> "canBus": "CAN1"</code>

			<code> }</code>

			<code>]</code>

			==== 8. List signals for a signal source ====
			For the A2L signal source listed in step 7 we can list the available signals for that source using: https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html#resource_EditSignalReaderAssignmentService_getSignalsForSignalSource_id_source_offset_limit_POST
			[[File:List signals for signal source.png\|thumb\|List signals for signal source]]
			A request and response example can be seen in the screenshot to the right.

			==== 9. List measurement setups for an assignment ====
			To add any signal from step 8 to any recorder in the assignment we first need to get the recorder we want to add the signal(s) to. This is done via: https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html#resource_EditSignalReaderAssignmentService_getMeasurementSetups_id_GET
			[[File:List measurement setups.png\|thumb\|List measurement setups]]
			From the response in the example to the right we can extract the JSON of the recorder we want to add the signal to:

			<code>{</code>

			<code> "trigger-name": "TR_1",</code>

			<code> "measurement-setup-name": "MS_1",</code>

			<code> "type": "SREC"</code>

			<code>}</code>

			==== 10. Add signal to SREC ====
			To add one or multiple signals to a recorder we use: https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html#resource_EditSignalReaderAssignmentService_addSRECs_id_signals_source_recorder_PUT
			[[File:Add signals to SREC.png\|thumb\|Add signals to SREC]]
			Here we need to provide a list of signals we want to add (step 8), the source of signals (step 7) and the recorder we want to add the signals to (step 9). An example can be seen in the screenshot to the right.

Alkitjohan: /* 4. Associate A2L file with ECU */

2024-12-19T16:04:01Z

4. Associate A2L file with ECU

← Older revision		Revision as of 16:04, 19 December 2024
Line 98:		Line 98:
	[[File:Associate A2L via GUI.png\|thumb\|Associate A2L via GUI]]		[[File:Associate A2L via GUI.png\|thumb\|Associate A2L via GUI]]
	A request example with a successful response can be seen in the screenshot to the right. The ID of the uploaded A2L file from step 1 along with the CAN bus number of the ECU is provided. This is the same as when selecting the CAN bus and the A2L file when association a file with an ECU using the portal GUI. An example can also be seen in a screenshot to the right.		A request example with a successful response can be seen in the screenshot to the right. The ID of the uploaded A2L file from step 1 along with the CAN bus number of the ECU is provided. This is the same as when selecting the CAN bus and the A2L file when association a file with an ECU using the portal GUI. An example can also be seen in a screenshot to the right.

			The successful response in this step may be:

			<code>{</code>

			<code> "ecu-name": "ABC",</code>

			<code> "can-bus-number": 1,</code>

			<code> "seedkey-id": 0,</code>

			<code> "a2l-file-id": 3,</code>

			<code> "association-id": 2,</code>

			<code> "type": "A2L"</code>

			<code>}</code>

			==== 5. List signal reader assignments ====
			Now is the vehicle profile updated with the new A2L file and it's time to copy the assignment. To know which assignment to copy we can list the assignments via https://wice.alkit.se/m2m/resource_AssignmentService.html#resource_AssignmentService_listAssignments_type_offset_limit_GET
			[[File:List signal reader assignments.png\|thumb\|List signal reader assignments]]
			An example request can be seen in the screenshot to the right. An example response is:

			<code>{</code>

			<code> "count": 1,</code>

			<code> "offset": 0,</code>

			<code> "limit": 25,</code>

			<code> "results": [</code>

			<code> {</code>

			<code> "name": "workshop_assignment",</code>

			<code> "type": "signal_reader",</code>

			<code> "id": 1</code>

			<code> }</code>

			<code> ]</code>

			<code>}</code>

			==== 6. Copy signal reader assignment ====
			With the id of the assignment obtained in step 5 we can use the copy assignment end point to make a copy of the assignment: https://wice.alkit.se/m2m/resource_AssignmentService.html#resource_AssignmentService_copySignalReaderAssignment_id_convert_ecuToDescriptionFiles_noTimeout_POST
			[[File:Copy signal reader assignment.png\|thumb\|Copy signal reader assignment]]
			Since the vehicle profile the assignment is based on has changed the assignment may need to be converted. In the example to the right we provide the flag convert=true which will automatically convert the assignment to the updated vehicle profile. If not included and the assignment needs to be converted a '400 Bad request' is returned with the message telling that the assignment needs be converted. We also provide the A2L file association we got in the response in step 4.
			[[File:Select A2L for ECU via GUI.png\|thumb\|Select A2L for ECU via GUI]]
			This is the same step as when selecting an A2L file in "Select files for ECUs" when copying an A2L file based assignment via the portal GUI. See screenshot. If the association is not provided, the selected signals from the A2L file source will be removed from the assignment.

Alkitjohan at 15:50, 19 December 2024

2024-12-19T15:50:27Z

← Older revision		Revision as of 15:50, 19 December 2024
Line 92:		Line 92:

	<code>]</code>		<code>]</code>

			==== 4. Associate A2L file with ECU ====
			To associate the uploaded A2L file with the ECU "ABC" in the response of step 3 above the following end point is used: https://wice.alkit.se/m2m/resource_VehicleProfileService.html#resource_VehicleProfileService_addEcuA2LAssociation_profileID_toBeMade_PUT
			[[File:Associate A2L file with ECU.png\|thumb\|Associate A2L file with ECU]]
			[[File:Associate A2L via GUI.png\|thumb\|Associate A2L via GUI]]
			A request example with a successful response can be seen in the screenshot to the right. The ID of the uploaded A2L file from step 1 along with the CAN bus number of the ECU is provided. This is the same as when selecting the CAN bus and the A2L file when association a file with an ECU using the portal GUI. An example can also be seen in a screenshot to the right.

Alkitjohan at 14:55, 19 December 2024

2024-12-19T14:55:40Z

← Older revision		Revision as of 14:55, 19 December 2024
Line 69:		Line 69:

	<code>}</code>		<code>}</code>

			==== 3. List ECUS of a vehicle profile ====
			To know which ECU in the vehicle profile we want to associated the A2L file with we need to list the configured ECUs for the vehicle profile of interest. This is done via: https://wice.alkit.se/m2m/resource_VehicleProfileService.html#resource_VehicleProfileService_getEcuToA2LAssociatonSummary_profileID_GET

			Here we provide the "id" of the profile obtained in the previous step.

			A successful response may look like:

			<code>[</code>

			<code> {</code>

			<code> "ecu-name": "ABC",</code>

			<code> "can-bus-number": 1,</code>

			<code> "seedkey-id": 0,</code>

			<code> "nr-of-a2l-files": 1</code>

			<code> }</code>

			<code>]</code>

Alkitjohan at 14:52, 19 December 2024

2024-12-19T14:52:29Z

@@ Line 19: / Line 19: @@
 The same function via the GUI can be seen in screenshot "Upload A2L via portal".
-A successful response looks like:
+A successful response looks like:[[File:Upload A2L file via m2m.png|Upload A2L file via m2m|frame]]<code>[</code>
 <code>    {</code>
@@ Line 41: / Line 39: @@
 <code>    }</code>
-<code>]</code>[[File:Upload A2L file via m2m.png|thumb|Upload A2L file via m2m|center]]
+<code>]</code>[[File:Upload A2L via portal.png|Upload A2L via portal|frame]]
-[[File:Upload A2L via portal.png|center|thumb|Upload A2L via portal]]

Alkitjohan at 10:28, 19 December 2024

2024-12-19T10:28:47Z

@@ Line 17: / Line 17: @@
 When using Postman the necessary information is provided as in the screenshot to the right. The only required attribute is the "ecu-name".
-The same function via the GUI can be seen in screenshot "Upload A2L via portal"
+The same function via the GUI can be seen in screenshot "Upload A2L via portal".
 [[File:Upload A2L file via m2m.png|thumb|Upload A2L file via m2m|center]]
 [[File:Upload A2L via portal.png|center|thumb|Upload A2L via portal]]

Alkitjohan at 10:20, 19 December 2024

2024-12-19T10:20:34Z

← Older revision		Revision as of 10:20, 19 December 2024
Line 15:		Line 15:
	Uploading a new A2L is done via https://wice.alkit.se/m2m/resource_VehicleProfileService.html#resource_VehicleProfileService_uploadNewA2LFile_attributes_file_POST.		Uploading a new A2L is done via https://wice.alkit.se/m2m/resource_VehicleProfileService.html#resource_VehicleProfileService_uploadNewA2LFile_attributes_file_POST.

	When using Postman the necessary information is provided as in the screenshot to the right.		When using Postman the necessary information is provided as in the screenshot to the right. The only required attribute is the "ecu-name".
	[[File:Upload A2L file via m2m.png\|thumb\|Upload A2L file via m2m]]
			The same function via the GUI can be seen in screenshot "Upload A2L via portal"
			[[File:Upload A2L file via m2m.png\|thumb\|Upload A2L file via m2m\|center]]
			[[File:Upload A2L via portal.png\|center\|thumb\|Upload A2L via portal]]

Alkitjohan at 10:14, 19 December 2024

2024-12-19T10:14:55Z

← Older revision		Revision as of 10:14, 19 December 2024
Line 12:		Line 12:
	The following sections describes how to do this via M2M.		The following sections describes how to do this via M2M.

	==== ~~Update vehicle profile~~ ====		==== 1. Upload new A2L file ====
			Uploading a new A2L is done via https://wice.alkit.se/m2m/resource_VehicleProfileService.html#resource_VehicleProfileService_uploadNewA2LFile_attributes_file_POST.

			When using Postman the necessary information is provided as in the screenshot to the right.
			[[File:Upload A2L file via m2m.png\|thumb\|Upload A2L file via m2m]]

Alkitjohan: Created page with "From version 1.47.0 of the API, Signal reader assignments can be edited via the API. The currently available end points for editing a specific assignment is described at https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html Editing an assignment is done by combining results from multiple end points and to help the user the sections below describes some use cases. === Add A2L signals from updated vehicle profile === One use case is when an assignment..."

2024-12-19T09:39:55Z

Created page with "From version 1.47.0 of the API, Signal reader assignments can be edited via the API. The currently available end points for editing a specific assignment is described at https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html Editing an assignment is done by combining results from multiple end points and to help the user the sections below describes some use cases. === Add A2L signals from updated vehicle profile === One use case is when an assignment..."

New page

From version 1.47.0 of the API, Signal reader assignments can be edited via the API. The currently available end points for editing a specific assignment is described at https://wice.alkit.se/m2m/resource_EditSignalReaderAssignmentService.html

Editing an assignment is done by combining results from multiple end points and to help the user the sections below describes some use cases.

=== Add A2L signals from updated vehicle profile ===
One use case is when an assignment "A" is based on a vehicle profile "VP" which has A2L files associated with at least one ECU. Then a new version of the A2L file is available which contains additional signals that needs to be measured in A.

When using the portal GUI one would start with uploading the A2L file and then associate it with the ECU of the VP. After that A needs to be copied (to use the updated version of VP) and the new A2L file needs to be selected when A is copied.

After the copying process is successful the assignment can be edited and the additional signals of the new A2L file are available when selecting the signals from the signal source.

The following sections describes how to do this via M2M.

==== Update vehicle profile ====