Merge pull request #341 from smartdevicelink/release/1.2.0

1.2.0 Release

Author: renonick87

.eslintrc

@@ -111,7 +111,6 @@
         "jsdoc/check-param-names": 1,
         "jsdoc/check-property-names": 1,
         "jsdoc/check-tag-names": 1,
-        "jsdoc/check-values": 1,
         "jsdoc/empty-tags": 1,
         "jsdoc/implements-on-classes": 1,
         "jsdoc/require-description": 1,

.gitignore

@@ -9,3 +9,5 @@
 *.pytest_cache
 hello-sdl*.zip
 app-directory.json
+**/dist/
+**/SDL.min.js

README.md

@@ -55,3 +55,13 @@ The JavaScript library will be open source and stored in a new smartdevicelink r
 The development should be done in JavaScript (not TypeScript) following ECMA-Script 2017. All the base source code should be developed using [JavaScript standard built-in objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects).
 
 The transport related source code for Node.js can use Node specific libraries needed (like socket.io). This code should be stored in a separate folder from the base source code in the repository.
+
+### Building the Project
+NodeJS, npm, and Python3 are required:
+
+```js
+npm install
+npm run build
+```
+
+The output will be in the `dist` folder. There is a vanilla JS and a NodeJS build, which can be placed into the corresponding example apps in the `examples` folder to test out the library.

examples/js/hello-sdl/SDL.min.js

@@ -53,7 +53,7 @@
                     .setLanguageDesired(SDL.rpc.enums.Language.EN_US)
                     .setHmiDisplayLanguageDesired(SDL.rpc.enums.Language.EN_US)
                     .setAppTypes([
-                        SDL.rpc.enums.AppHMIType.DEFAULT,
+                        SDL.rpc.enums.AppHMIType.MEDIA,
                     ])
                     .setTransportConfig(new SDL.transport.WebSocketClientConfig('ws://localhost', 5050))
                     .setAppIcon(file)
@@ -98,6 +98,7 @@
 
                 this._sdlManager = new SDL.manager.SdlManager(this._appConfig, managerListener);
                 this._sdlManager.start();
+                this._isButtonSubscriptionRequested = false;
             }
 
             async _onConnected () {
@@ -123,6 +124,8 @@
                 screenManager.setTextAlignment(SDL.rpc.enums.TextAlignment.RIGHT_ALIGNED);
                 screenManager.setPrimaryGraphic(new SDL.manager.file.filetypes.SdlArtwork('sdl-logo', SDL.rpc.enums.FileType.GRAPHIC_PNG)
                     .setFilePath(this._filePath));
+                screenManager.changeLayout(new SDL.rpc.structs.TemplateConfiguration()
+                    .setTemplate(SDL.rpc.enums.PredefinedLayout.NON_MEDIA));
             }
 
             async _onHmiStatusListener (onHmiStatus) {
@@ -131,6 +134,39 @@
 
                 // wait for the FULL state for more functionality
                 if (hmiLevel === SDL.rpc.enums.HMILevel.HMI_FULL) {
+                    const screenManager = this._sdlManager.getScreenManager();
+                    const isRpcAllowed = (rpc) => {
+                        return this._permissionManager &&
+                            this._permissionManager.isRpcAllowed(rpc);
+                    };
+
+                    if (!this._isButtonSubscriptionRequested && isRpcAllowed(SDL.rpc.enums.FunctionID.SubscribeButton)) {
+                        const availableButtons = this._sdlManager.getRegisterAppInterfaceResponse().getButtonCapabilities().map(function (capability) {
+                            return capability.getNameParam();
+                        });
+
+                        // add button listeners
+                        const ButtonName = SDL.rpc.enums.ButtonName;
+                        const buttonNames = [ButtonName.PRESET_0, ButtonName.PRESET_1, ButtonName.PRESET_2, ButtonName.PRESET_3,
+                                    ButtonName.PRESET_4, ButtonName.PRESET_5, ButtonName.PRESET_6, ButtonName.PRESET_7, ButtonName.PRESET_8,
+                                    ButtonName.PRESET_9, ButtonName.PLAY_PAUSE, ButtonName.OK, ButtonName.SEEKLEFT, ButtonName.SEEKRIGHT,
+                                    ButtonName.TUNEUP, ButtonName.TUNEDOWN];
+
+
+                        for (const buttonName of buttonNames) {
+                            if (availableButtons.indexOf(buttonName) !== -1) {
+                                console.log('Subscribing to', buttonName);
+                                await screenManager.addButtonListener(buttonName, this._onButtonListener.bind(this)).catch(function (err) {
+                                    console.error(err);
+                                });
+                            } else {
+                                console.log('No capability found for button', buttonName);
+                            }
+                        }
+
+                        this._isButtonSubscriptionRequested = true;
+                    }
+
                     const art1 = new SDL.manager.file.filetypes.SdlArtwork('logo', SDL.rpc.enums.FileType.GRAPHIC_PNG)
                         .setFilePath(this._filePath);
 
@@ -153,7 +189,6 @@
                     ];
 
                     // set the softbuttons now and rotate through the states of the first softbutton
-                    const screenManager = this._sdlManager.getScreenManager();
                     await screenManager.setSoftButtonObjects(softButtonObjects);
 
                     await this._sleep(2000);
@@ -164,12 +199,9 @@
 
                     const count = 3;
                     for (let i = 0; i < count; i++) {
-                        const showCountdown = new SDL.rpc.messages.Show();
-                        showCountdown.setMainField1(`Exiting in ${(count - i).toString()}`)
-                            .setMainField2('')
-                            .setMainField3('');
-
-                        this._sdlManager.sendRpcResolve(showCountdown); // don't wait for a response
+                        screenManager.setTextField1(`Exiting in ${(count - i).toString()}`)
+                            .setTextField2('')
+                            .setTextField3('');
 
                         await this._sleep();
                     }
@@ -187,6 +219,14 @@
                 });
             }
 
+            _onButtonListener (buttonName, onButton) {
+                if (onButton instanceof SDL.rpc.messages.OnButtonPress) {
+                    this._sdlManager.getScreenManager().setTextField1(`${buttonName} pressed`);
+                } else if (onButton instanceof SDL.rpc.messages.OnButtonEvent) {
+                    this._sdlManager.getScreenManager().setTextField2(`${buttonName} ${onButton.getButtonEventMode()}`);
+                }
+            }
+
             _logPermissions () {
                 if (this._permissionManager) {
                     console.log(`Show RPC allowed: ${this._permissionManager.isRpcAllowed(SDL.rpc.enums.FunctionID.Show)}`);

examples/js/hello-sdl/index.html

@@ -1,4 +1,5 @@
 ## SDL JavaScript App Startup Instructions
+1) Place the vanilla JS SDL.min.js file into this directory
 1) Request a [Manticore instance](https://smartdevicelink.com/resources/manticore/)
 1) Open two terminal sessions and `cd` both of them into `./examples/js/hello-sdl`
 1) In one terminal session, run `java -jar proxy.jar m.sdl.tools [PORT]`, where `[PORT]` is the one given to you by Manticore