smartdevicelink/sdl_app_library_guides

DocDown Guide Content for

sdl_app_library_guides's Issues

Add documentation for Scrollable Message

• Create a Scrollable Message
  • Message Text
  • Timeout
  • Buttons
• Show the Scrollable Message

Move to Generic HMI-only images as much as possible

Use same app for template screenshots on SYNC 3 & Generic HMI

We currently use two different apps for the template screenshots in Displaying the User Interface > Designing the User Interface. The screen shots should be updated so they both have the same format/images.

Create new section for Customizing the OS Look and Functionality

Customizing the OS Look and Functionality

• Set a custom menu title and icon
• Set custom help prompts
• Set a customized keyboard (includes language, layout, auto complete text, keypress mode
  • This is currently handled by the PICS manager so we should warn users that whatever they set might be overridden.

wrong app service initializer in example

in the ios docs for creating an app service, the example shows:
SDLAppServiceManifest *manifest = [[SDLAppServiceManifest alloc] initWithServiceType:SDLAppServiceTypeMedia];
when it should be:
SDLAppServiceManifest *manifest = [[SDLAppServiceManifest alloc] initWithAppServiceType:SDLAppServiceTypeMedia];

Those examples should be combed through to make sure initializer changes are updated

Create new section Working with the Navigation App

Working with the Navigation App

• Sending a Location (SendLocation)
• Updating the Turn List (UpdateTurnList)
• Getting the Navigation Waypoints (GetWaypoints, SubscribeWaypoints, UnsubscribeWaypoints)

Update Swift code samples to Swift 5

Current Swift code samples are mostly written in Swift 3. Check all Swift code samples in the guides and make sure they are up to date.

Example App needs troubleshooting instructions

1. TCP debugging help
   • Make sure to set the correct IP address and port number in the SDLLifecycleConfiguration.
   • Make sure the device and SDL Core are on the same network
   • If running SDL Core on a virtual machine, and you are using port forwarding to connect your device to the virtual machine, the IP address should be the IP address of your machine hosting the VM, not the IP address of the VM. The port number will be 12345.
   • Make sure there is no firewall blocking the incoming port 12345 on the machine or VM running SDL Core. Also make sure your firewall allows that outgoing port.
   • When app on the device is backgrounded, the app will be unable to communicate with SDL Core. This will work on IAP connections.
   • Audio will not play when using a TCP connection. Only IAP connections are currently able to play audio because this happens over the standard Bluetooth / USB system audio channel.
2. iAP debugging help
   • Make sure to use the default SDLLifecycleConfiguration
   • Make sure the protocol strings have been added to the app
   • Make sure you have enabled background capabilities for your app
   • If the head unit does not support a bluetooth, an iAP connection requires a USB cord.
3. Bluetooth debugging help
   • Make sure the head unit supports bluetooth transport for iPhones. Currently, only some proaction head units support bluetooth.
   • Make sure to use the default SDLLifecycleConfiguration
   • Make sure Bluetooth is turned on - on Both the TDK and your iPhone
   • Ensure your iPhone is properly paired with the TDK

Remote Control - Allow Multiple Modules

#100

Add iOS 6.3 guide content

• Dynamic Menu Cell Updating
• SDLAudioStreamManager pushData
• SDLSystemCapabilityManager subscriptions
• SDLManager RPC subscriptions

Add more information about soft buttons

1. Add a section about how to create each type of button: image, text, and both
2. Add instructions on how to find out template supports images in its soft buttons
3. Instructions how to delete a soft button(s)

Incorrect handling of Language Change for Java

The JavaSE and JavaEE guides include documentation that would work for Android, however, they will not work for JavaSE or JavaEE. See here

Update video streaming guides to have info on how to present other templates for various purposes

Better Align Adapting to the Head Unit Language

Add documentation for Slider

• Layout
• Create a Slider
  • Slider Range
  • Set the Position of the Slider Control
  • Header
  • Footer
  • Timeout
• Show the Slider
• Get the User's Selected Position

Template Titles - Fall 2019 Documentation

Fixes #100

Update documentation to show a title can be set

Alert Icon

Fixies Issues #100

Adding Alert Icon Documentation Example

Add SdlRouterService Manifest example

There are currently many steps to add items for the SdlRouterService in the manifest, but we are missing an example one that developers can copy. This can lead to missing the note about the router service needing to be ran in a different process.

        <service
            android:name=".SdlRouterService"
            android:enabled="true"
            android:exported="true"
            android:process="com.smartdevicelink.router">
            <meta-data android:name="sdl_router_version"  android:value="@integer/sdl_router_service_version_value" />

            <intent-filter>
                <action android:name="com.smartdevicelink.router.service"/>
            </intent-filter>
        </service>

Provide supported system capabilities by RPC Spec Version

Add information with which capabilities are supported on which versions of the RPC Spec.

This is a placeholder issue for now, and the defined capabilities per version should be specified in this issue before a PR is submitted to add the information.

Fall 2019 App Library Update Documentation

• New RPC UnpublishAppService means an app can only publish one service of the same type in the future. (Make sure to update guide documentation that says multiple services of the same type can be published by the same app)

• Alert Icon

• Template Titles

• Cancel Interaction

• Main Menu Tiles

• Open Menu

• Dismissable Lock Screen

• Disable Lock Screen Dismiss Gesture

• AutoCompleteList

• MediaServiceData MediaImage

• Update Published App Services

• SyncMsgVersion -> SDLMsgVersion

• Navigation Subscription Buttons

• GPS Shift support (?)

• Close Application

• Widgets (Will not be in this release, will wait until managers exist to avoid re-writing a massive amount of guides)

• Pixel Density and Scale

• RPC Message Protection

• Remote Control Multiple Modules

• Generic Network Signal Data (?)

• Change Registration (Java only)

• Update library version in installation page

Add soft button highlighting instructions

The Displaying a User Interface > Text Images and Buttons needs instructions on how to "highlight" and "unhighlight" a soft button using the screen manager.

Multiple Transports

Should have:

1. Information about how multiple transports works
2. If supported, a secondary transport is configured automatically by the library

The "Adding the Lock Screen" section needs screenshots

The "Adding the Lock Screen" section needs screenshots of the lock screens on an Android phone. The iOS platform has screenshots already of lock screens on an iPhone

Add more information to the Alerts section

The alert section should be reformatted and more information should be added for each of parameters.

• Layouts
  • Alert with no soft buttons
  • Alert with soft buttons
• Create the Alert
  • Timeout (if soft buttons are added, the timeout does not work)
  • Progress Indicator
  • Text-To-Speech
  • Play Tone
  • Buttons
• Show the Alert
• Example

Add information about the File Manager Configuration

In the Getting Started > Integration Basics section, add information about how to configure the SDLFileManagerConfiguration to re-upload failed files and artworks. The default configuration attempts a re-upload once.

Add information about how to create a persistent lock screen

To keep the lock screen always visible, even when the car is stationary, the SDLLockScreenConfiguration's showInOptionalState should be set to true.

@NicoleYarroch this branch has conflicts

@NicoleYarroch this branch has conflicts

Originally posted by @joeljfischer in #78 (comment)

Fixed.

Calling a Phone Number title header is broken

The first header in the Calling a Phone Number section is broken because there is a space before the #.

SyncMsgVersion -> SDLMsgVersion

Fixes #100

Add preset button instructions

Add instructions on how to use the preset subscribe buttons. Add new section Preset Buttons to existing guide in Displaying a User Interface > Subscribing to System Buttons..

Information Needed:

1. Why use preset buttons?
2. Which templates allow the preset soft buttons?
3. Get image of template with "Presets" button

What to Include:

1. How to create and send a preset button
2. How to react to preset button selection

Add a README

Should include:

• Valid tags
• Configuring the config file
• Configuring a guide
• Best practices: SmartDeviceLink should be shortened to SDL not Sdl or sdl, screenshots on both Ford SYNC 3 and Generic HMI should be included when possible.

Improve (and combine?) iOS Touch Manager / Haptic Rect Guide

• It's unclear how to get the view property in the touch manager delegate callbacks.

Fix iOS Creating an App Service Example Code

response.resultCode = SDLVehicleDataResultCodeSuccess;

Should be

response.resultCode = SDLResultCodeSuccess;

Update Installation for Accio support

Update choice set imagery with all available SDLChoice fields

https://smartdevicelink.com/en/guides/iOS/displaying-a-user-interface/popup-menus-and-keyboards/

AutoCompleteList - Fall 2019 Documentation

Update mirroring onscreen display for the `CarWindow` documentation

Add more detail about on-screen mirroring using the CarWindow API

• Getting the topmost view controller using UIApplication.shared.keyWindow.rootViewController is not going to work as this will give you the lock screen view controller. The projected image will be distorted because the view controller you want to project will not be resized correctly.
• The initial streaming media manager rootViewController should be set in the viewDidAppear:animated of the UIViewController
• We do not recommend on-screen mirroring, however if you must do on-screen mirroring, the lock screen should be configured so that it is always showing while connected to the head unit.

Add Installation via Swift Package Manager using Xcode 11

Update iOS Example Apps Guide to better match the Android guide

Better Align the Integration Basics Guides

Update "Getting and Subscribing to Available Services" code sample

The Using App Services > Getting and Subscribing to Services code sample should use the new SDLSystemCapabilityManager subscribeToCapabilityType:withBlock: method.

Build React Native App

Add Android 4.9 guide content

Align Streaming / Audio

Create a new section for Audio

Add new section for audio related RPCs.

Voice Commands and Audio

• Global Voice Commands
• Custom Text-to-Speech
• Getting In-Car Microphone Audio
• Playing Audio Indicators

Add `GetFile` RPC documentation to the App Services guides

Add information about how to use GetFile to retrieve image data in the Using App Services guide.

Change Template Guides

The Text Images and Buttons guide should be split into:

1. Template Text
2. Template Images
3. Template Buttons (fold in the system buttons guide to here)

Open Menu

Add Documentation to Open Menu

Fixies: #100

VideoStreaming Menu

Will include issues
#119
#121

Close Application

Add Documentation for Close Application RPC

Fixes: #100