Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OnPutFile documentation #156

Merged
merged 1 commit into from
Jul 10, 2019
Merged

Update OnPutFile documentation #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/BasicCommunication/OnPutFile/assets/OnPutFileBeforeRPC.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 8 additions & 7 deletions docs/BasicCommunication/OnPutFile/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Purpose

!!! MUST

1. Use the appropriate uploaded file according to its workflow (IVSU, SystemRequest, RPC's). See diagrams listed below.
1. If `isSystemFile` is set to true, use the appropriate uploaded file according to its workflow (IVSU, SystemRequest, RPC's). See diagrams listed below.
2. Whenever HMI gets RPC with `Image` which has `.isTemplate` set to true, the HMI has to:

- load the proper image pattern
Expand Down Expand Up @@ -51,10 +51,11 @@ The list of RPCs and data structures that `OnPutFile` affects are:
|offset|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
|length|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
|fileSize|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
|FileName|String|true|maxlength: 255|
|syncFileName|String|true|maxlength: 255|
|fileType|[Common.FileType](../../common/enums/#filetype)|true||
|persistentFile|Boolean|false||
|isSystemFile|Boolean|false||
|appID|Integer|false||

### Sequence Diagrams
|||
Expand All @@ -74,10 +75,10 @@ System Request file upload using Put File
```json
{
"jsonrpc" : "2.0",
"method" : "BasicCommunication.OnPutFile"
{
"fileName":"/fs/sharedFolder/app1_device1/icon.jpg",
"fileType":"GRAPHIC_JPEG"
}
"method" : "BasicCommunication.OnPutFile",
"params" : {
"syncFileName":"/fs/sharedFolder/app1_device1/icon.jpg",
"fileType":"GRAPHIC_JPEG"
}
}
```