WICE RP How-To - Revision history

Mathias at 12:11, 21 August 2023

2023-08-21T12:11:47Z

@@ Line 193: / Line 193: @@
   <code>send(pubsub_socket, "quit", 4, 0);
    close(pubsub_socket);</code>
+As another example, the following Python code illustrates how to set up a socket connection th the Signal Broker, list the available signals, and subscribe to them.
 You can find more information about the signal broker API in [[WICE Signal Broker API]] section.

Jonas: Fixed some URL crap. Adding a '/' at the end made it work.

2020-05-20T08:46:23Z

Fixed some URL crap. Adding a '/' at the end made it work.

← Older revision		Revision as of 08:46, 20 May 2020
Line 52:		Line 52:
	The example shows how to read a configuration file supplied on the command line, to write a CAN diagnostic request on a CAN bus and read a diagnostic reply, and to log data to a log file that will be uploaded to the WICE Portal.		The example shows how to read a configuration file supplied on the command line, to write a CAN diagnostic request on a CAN bus and read a diagnostic reply, and to log data to a log file that will be uploaded to the WICE Portal.

	The full source code of rpex is available [~~http~~://www.alkit.se/rp/example here].		The full source code of rpex is available [https://www.alkit.se/rp/example/ here].

	The first thing the example program does is to parse the command line parameters:		The first thing the example program does is to parse the command line parameters:
Line 130:		Line 130:
	To avoid the intricacies of reading CAN or FlexRay signals directly from the device, having to parse and interpret the signals, there is a high-level socket based API for reading in-vehicle and WICE-internal signals. The API is based on a publish/subscribe model, wherein the RP client subscribes to signals by name, and periodically gets signal values for the selected set of signals. The communication between the RP client and the WICE signal broker component is done over a socket.		To avoid the intricacies of reading CAN or FlexRay signals directly from the device, having to parse and interpret the signals, there is a high-level socket based API for reading in-vehicle and WICE-internal signals. The API is based on a publish/subscribe model, wherein the RP client subscribes to signals by name, and periodically gets signal values for the selected set of signals. The communication between the RP client and the WICE signal broker component is done over a socket.

	The example code <code>rpex-pubsub.c</code> illustrates how to use the publish/subscribe API. The full source code is available [~~http~~://www.alkit.se/rp/example here].		The example code <code>rpex-pubsub.c</code> illustrates how to use the publish/subscribe API. The full source code is available [https://www.alkit.se/rp/example/ here].

	To set up the communication between the RP module and the signal broker, the example program calls a function called <code>setup_pubsub_connection()</code> after parsing the command line parameters:		To set up the communication between the RP module and the signal broker, the example program calls a function called <code>setup_pubsub_connection()</code> after parsing the command line parameters:
Line 279:		Line 279:
	The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>.		The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>.

	A complete example of a Node web-application RP zip-file, including source code, is available for download [~~http~~://www.alkit.se/rp/node-example here].		A complete example of a Node web-application RP zip-file, including source code, is available for download [https://www.alkit.se/rp/node-example/ here].

Jonas: /* Software Development Toolchain */

2020-05-07T11:24:52Z

Software Development Toolchain

← Older revision		Revision as of 11:24, 7 May 2020
Line 14:		Line 14:

	All toolchains are gcc-based.		All toolchains are gcc-based.
	The MX-4 toolchain is availble here: ~~http~~://www.alkit.se/pub/gcc-linaro-arm-linux-gnueabihf-2012.09-20120921_linux.tar.gz		The MX-4 toolchain is availble here: https://www.alkit.se/pub/gcc-linaro-arm-linux-gnueabihf-2012.09-20120921_linux.tar.gz

	== WICE RP development API libraries ==		== WICE RP development API libraries ==
Line 24:		Line 24:
	* OBD II library		* OBD II library

	The development libraries are available here: ~~http~~://www.alkit.se/rp/libs/		The development libraries are available here: https://www.alkit.se/rp/libs/

	Note that you do not need these libraries when using the high-level Signal Broker API (the preferred approach), described below.		Note that you do not need these libraries when using the high-level Signal Broker API (the preferred approach), described below.

Mathias: /* Building and executing the RP program */

2020-03-27T08:52:34Z

Building and executing the RP program

← Older revision		Revision as of 08:52, 27 March 2020
Line 45:		Line 45:
	The <code>-logfile</code> parameter supplies the path to a debug log file which will be uploaded to WICE portal when the RP module exits.		The <code>-logfile</code> parameter supplies the path to a debug log file which will be uploaded to WICE portal when the RP module exits.

	To get access to the information supplied on the command line at ~~star~~-~~upt~~, the RP program must parse the command line.		To get access to the information supplied on the command line at start-up, the RP program must parse the command line.

	= A simple example RP program =		= A simple example RP program =

Mathias: /* WICE RP development API libraries */

2020-03-27T08:52:20Z

WICE RP development API libraries

← Older revision		Revision as of 08:52, 27 March 2020
Line 25:		Line 25:

	The development libraries are available here: http://www.alkit.se/rp/libs/		The development libraries are available here: http://www.alkit.se/rp/libs/

			Note that you do not need these libraries when using the high-level Signal Broker API (the preferred approach), described below.

	= Building and executing the RP program =		= Building and executing the RP program =

Mathias: /* Getting Started with WICE Rapid Prototyping */

2020-03-27T08:51:52Z

Getting Started with WICE Rapid Prototyping

← Older revision		Revision as of 08:51, 27 March 2020
Line 3:		Line 3:
	* A toolchain for building executable programs on the target WCU platform		* A toolchain for building executable programs on the target WCU platform
	* A set of libraries providing APIs to the WCU hardware platform resources (e.g. CAN, diagnostics, logging, etc)		* A set of libraries providing APIs to the WCU hardware platform resources (e.g. CAN, diagnostics, logging, etc)
			* A high-level, socket based, Signal Broker API simplifying access to in-vehicle signals.
	* WICE Portal access to configure the RP module for one or more WCUs		* WICE Portal access to configure the RP module for one or more WCUs

Mathias: /* Software Development Toolchain */

2020-03-27T07:58:19Z

Software Development Toolchain

← Older revision		Revision as of 07:58, 27 March 2020
Line 13:		Line 13:

	All toolchains are gcc-based.		All toolchains are gcc-based.
	The MX-4 toolchain is availble here: http://~~releases~~.~~linaro.org/13~~.09/~~components/toolchain~~/gcc-linaro/4.7		The MX-4 toolchain is availble here: http://www.alkit.se/pub/gcc-linaro-arm-linux-gnueabihf-2012.09-20120921_linux.tar.gz

	== WICE RP development API libraries ==		== WICE RP development API libraries ==

Max.h.petersson: /* Rapid Prototyping using Node.js */ added log file handling.

2019-11-08T10:03:22Z

Rapid Prototyping using Node.js: added log file handling.

← Older revision		Revision as of 10:03, 8 November 2019
Line 195:		Line 195:
	= Rapid Prototyping using Node.js =		= Rapid Prototyping using Node.js =
	To develop Rapid Prototyping applications with graphical user interfaces, the [https://nodejs.org Node.js] framework can be used. Node.js is a cross-platform JavaScript run-time environment that executes JavaScript code on the server side. In the WICE RP concept, a Node.js application can be downloaded to a WCU where it is executed. The user interface developed can be accessed from a web browser connected to the WCU through Ethernet or WiFi. The setup described here is built with Node.js Express. However, other frameworks can be utilized using the same methodology, with small modifications.		To develop Rapid Prototyping applications with graphical user interfaces, the [https://nodejs.org Node.js] framework can be used. Node.js is a cross-platform JavaScript run-time environment that executes JavaScript code on the server side. In the WICE RP concept, a Node.js application can be downloaded to a WCU where it is executed. The user interface developed can be accessed from a web browser connected to the WCU through Ethernet or WiFi. The setup described here is built with Node.js Express. However, other frameworks can be utilized using the same methodology, with small modifications.

			All written to consol.log() will be in a log-file called rp-webapp-<date>.log and uploaded and accessible in the WICE back end.

	The following example demonstrates how to access vehicle signals from a Node.js application running on a WCU.		The following example demonstrates how to access vehicle signals from a Node.js application running on a WCU.

Mathias: /* Rapid Prototyping using Node.js */

2018-09-04T13:18:54Z

Rapid Prototyping using Node.js

← Older revision		Revision as of 13:18, 4 September 2018
Line 272:		Line 272:

	To transfer a Node web-app to one or more WCUs, it should be put in a zip file and uploaded to the WICE Portal as an RP module.		To transfer a Node web-app to one or more WCUs, it should be put in a zip file and uploaded to the WICE Portal as an RP module.
	The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>		The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>.

	A complete example of a Node web-application RP zip-file, including source code, is available for download [http://www.alkit.se/rp/node-example here].		A complete example of a Node web-application RP zip-file, including source code, is available for download [http://www.alkit.se/rp/node-example here].

Mathias: /* Rapid Prototyping using Node.js */

2018-09-04T13:18:01Z

Rapid Prototyping using Node.js

← Older revision		Revision as of 13:18, 4 September 2018
Line 271:		Line 271:
	});</code>		});</code>

	To transfer a Node web-app to one or more WCUs, it should be put in a zip file and uploaded to the WICE Portal ~~and~~ an RP module.		To transfer a Node web-app to one or more WCUs, it should be put in a zip file and uploaded to the WICE Portal as an RP module.
	The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>		The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>
	A complete example of a Node web-application RP zip-file, including source code, is available for download [http://www.alkit.se/rp/node-example here].		A complete example of a Node web-application RP zip-file, including source code, is available for download [http://www.alkit.se/rp/node-example here].