On Compatibility FrancaIDL and CommonAPI

189 views
Skip to first unread message

Dolly Yadav

unread,
Sep 23, 2019, 7:08:12 AM9/23/19
to Franca
Hello,

Please let me know which version of CommonAPI is compatible with FrancaIDL 13.1

Thank you.

Klaus Birken

unread,
Sep 23, 2019, 8:46:26 AM9/23/19
to Franca
Hi,

unfortunately, the CommonAPI team didn't update their product and thus CommonAPI will support only the 0.9.x version of Franca. See also the Compatibility-Overview wiki page for more information on this.

But keep in mind that this compatibility only means that Franca and CommonAPI can be installed in the same Eclipse installation. What could be done anyway is to use fidl-files created with a later version of Franca (e.g., 0.13) and feed them into Common API 3.x. Except from some minor incompatibilities, this will work properly.

Regards,
Klaus

siddhartha v

unread,
Sep 23, 2019, 9:04:56 AM9/23/19
to Klaus Birken, Franca
OK, thanks for the information sir. 

Will it be able to work with franca (13.1) for Web (HTML, JS, CSS) client with common API wamp server can we use latest version common API (3.1.12)?
Because the common API generators version should match with the runtime version. 

Is there any referral example projects where franca html /js client being implemented wd common API c++ wamp server. 

I kindly request you to help me on this.





Thanks.
Siddhartha V 

--
You received this message because you are subscribed to the Google Groups "Franca" group.
To unsubscribe from this group and stop receiving emails from it, send an email to franca-framewo...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/franca-framework/945888f3-0747-4284-9c2f-2b1b03a5f4ba%40googlegroups.com.

siddhartha v

unread,
Sep 23, 2019, 9:17:06 AM9/23/19
to Klaus Birken, Franca
I referred below two links, the client part is somewhat clear but server part is not clear.

Two links that I mensioned:

https://github.com/kbirken/franca-html5-showcase (client from here)

 

https://github.com/GENIVI/capicxx-wamp-tools/tree/master/org.genivi.commonapi.wamp.examples (server from here)



I want to know how can I proceed further in this case. Please help me on this issue sir.


Thanks 

Siddhartha V 

Klaus Birken

unread,
Sep 23, 2019, 5:14:04 PM9/23/19
to Franca
Hi,

there are two github projects, one with the tools (basically the code generator for the CommonAPI server side) and on with the runtime. You will need CommonAPI 3.1.12 on the server side (here, CommonAPI generator version must match with the C++ runtime). Both repositories have a README file, where everything is explained. For the client side, you need Franca 0.13. This mixed versions are not a problem, because you won't use CommonAPI on the client for the WAMP middleware. The client is just some generated JS code, which is generated by the codegenerator of Franca 0.13.

Some examples with an additional README are part of the tool repo: https://github.com/GENIVI/capicxx-wamp-tools/tree/master/org.genivi.commonapi.wamp.examples

Regards,
Klaus


Am Montag, 23. September 2019 15:04:56 UTC+2 schrieb siddhartha v:
OK, thanks for the information sir. 

Will it be able to work with franca (13.1) for Web (HTML, JS, CSS) client with common API wamp server can we use latest version common API (3.1.12)?
Because the common API generators version should match with the runtime version. 

Is there any referral example projects where franca html /js client being implemented wd common API c++ wamp server. 

I kindly request you to help me on this.





Thanks.
Siddhartha V 

Klaus Birken

unread,
Sep 23, 2019, 5:15:46 PM9/23/19
to Franca
The franca-html5-showcase link is not for the WAMP solution - it is for an older solution based on WebSockets. The older solution didn't use CommonAPI.


Am Montag, 23. September 2019 15:17:06 UTC+2 schrieb siddhartha v:
I referred below two links, the client part is somewhat clear but server part is not clear.

Two links that I mensioned:

https://github.com/kbirken/franca-html5-showcase (client from here)

 

https://github.com/GENIVI/capicxx-wamp-tools/tree/master/org.genivi.commonapi.wamp.examples (server from here)



I want to know how can I proceed further in this case. Please help me on this issue sir.


Thanks 

Siddhartha V 


OK, thanks for the information sir. 

Will it be able to work with franca (13.1) for Web (HTML, JS, CSS) client with common API wamp server can we use latest version common API (3.1.12)?
Because the common API generators version should match with the runtime version. 

Is there any referral example projects where franca html /js client being implemented wd common API c++ wamp server. 

I kindly request you to help me on this.





Thanks.
Siddhartha V 

Dolly Yadav

unread,
Sep 24, 2019, 2:32:14 AM9/24/19
to Franca
Hello Sir,

I just wrote the below code:

package commonapi
interface HelloWorld
 { 
     version { major 0 minor 1 }
     method sayHello
       { 
         in 
             {  String name }
         out 
             { String message }
       }
}


Franca 13 generated the below two files:
HelloworldClientBlueprint.js
HelloworldProxy.js

my doubt is:

1) Should we use the generated Blueprint file as our .js file to create the client application (or) should we create our own new .js file?

2) In case we need to use our own new .js file, then what is this (auto) generated HelloworldClientBlueprint.js file here for? How does this auto generated file help us?

3) As per my understanding, we need to call both - proxy.js and created .js file - in HTML file.  as below:
<!-- generated proxy classes -->
<script src="gen/org/example/SimpleUIProxy.js"></script>
<!-- own JS files -->
<script src="js/example-application.js"></script>
 
Is my understanding correct? If not please let me know the proper direction.

Moreover,
In the client side, my idea is to separate .js code from HTML and call "example-application.js" in the .html file (as shown above piece of code). Is this approach okay or should I proceed as per shown in the link ( https://github.com/GENIVI/capicxx-wamp-tools/tree/master/org.genivi.commonapi.wamp.examples ) that you have sent ( where the entire java script code is included in HTML (.html) file using <script> tag)? 

Thank you sir.

siddhartha v

unread,
Oct 15, 2019, 5:07:53 AM10/15/19
to Franca
Hello Dolly,


Proxy is the most important part it gives you the idea how client behaves,


Blueprint is just to show you how to use Proxy in order to communicate with a service.


You can either reuse the blueprint file (i.e calling blueprint in .html file) as you mentioned above or implement something from the scratch ( writing javascript part also in .html file using <script> tag), depending how it fits to the rest of your project.


Treat Blueprint as example, that’s it.


Another important part is you need to include autobahn library i.e autobahn.min.js to your client you need to call that file in the .html file as below


<!-- autobahn library -->
<script src="autobahn/autobahn.min.js"></script>

without which you cannot communicate with the server. 



Hope this helps.., ATB.



Regards,

Siddhartha

Dolly Yadav

unread,
Dec 3, 2019, 6:58:11 AM12/3/19
to Franca
Hello Sir,

I had downloaded CommonAPI C++ WAMP tools from this link - https://github.com/GENIVI/capicxx-wamp-tools

However, the above code generator doesn't support selective broadcast. Could you please help me with a code generator that supports selective broadcast.

Thank you.
Reply all
Reply to author
Forward
0 new messages