Skip to content

Conversation

@jacobkeeler
Copy link
Contributor

Documentation updates for Core release 5.0.0

jacobkeeler and others added 30 commits August 29, 2016 10:27
Files OnEmergencyEvent, OnPhoneCall were deleted.
OnEventChanged file was created.
PHONE_CALL, EMERGENCY_EVENT, DEACTIVATE_HMI, AUDIO_SOURCE, EMBEDDED_NAVI
events were described in OnEventChanged file.
Appropriate tables and diagrams were added.
OnEventChanged index was added
The list of affected RPCs was updated
Add LowVoltage index
Add low_voltage diagram
Add  
FuelRange struct
Add  
FuelType enum
element VEHICLEDATA_FUELRANGE to VehicleDataType
Add fuelRange, engineOilLife parameters
Add fuelRange, engineOilLife params
Add VEHICLEDATA_ENGINEOILLIFE to VehicleDataType
Add fuelRange, engineOilLife params to request and response
Add fuelRange, engineOilLife params to request and response
…lectronic_park_brake_status

Add TurnSignal and ElectronicParkBrakeStatus to vehicle data
Add displayName parameter to DisplayCapabilities
…ditions

Add new tire pressure parameters
* Add audioStreamingIndicator to SetMediaClockTimer
* Add note to image regarding invalid references
Add missing secondaryGraphic ImageFieldName
Addition of PLAY_PAUSE definition in ButtonName enum
@sdl-robot
Copy link

@sdl-robot
Copy link

@sdl-robot
Copy link

Copy link
Contributor

@theresalech theresalech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left a few formatting comments for you to review. Please let me know of any questions, thanks!

Purpose
: Inform HMI and mobile application about changes in RC module allocation.

!!! must
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this either needs to be removed, or !!! should be added to the end of the must block.


3) Respond with the [result code] correspondingly to the results of this RPC execution.
[result code]: https://github.com/smartdevicelink/sdl_hmi_integration_guidelines/blob/develop/docs/UI/SetMediaClockTimer/index.md#response
1. perform the update type indicated by the `updateMode` parameter:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to capitalize Perform to match the other formatting in this document.

1. perform the update type indicated by the `updateMode` parameter:
* If the application is not active, the HMI must still store the values to be calculated for later display on the HMI.
* If the application is active, the updates must begin immediately.
2. exhibit the following behavior based on the `updateMode` parameter:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to capitalize Exhibit to match the other formatting in this document.


!!! NOTE
1) SDL will not send this request if the `mediaClock` field is not indicated as supported in [UI.GetCapabilities](https://github.com/smartdevicelink/sdl_hmi_integration_guidelines/blob/master/docs/UI/GetCapabilities/index.md).
1) SDL will not send this request if the `mediaClock` field is not indicated as supported in [UI.GetCapabilities](../getcapabilities).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list should be updated to 1., 2., 3. as the parentheses don't format properly here: https://smartdevicelink.com/en/docs/pull_request/2b66bdcfe59b9f44a570112db83a3436de09fb83/ui/setmediaclocktimer/


!!!

_Note:_ SDL logs the corresponding error internally and fails the handshake process if at least one of the following failures occurs:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be formatted as a !!! NOTE ?

@jacobkeeler
Copy link
Contributor Author

@theresalech addressed review comments in f9a17cd

@sdl-robot
Copy link

@jacobkeeler jacobkeeler merged commit ba261a2 into master Oct 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants