Skip to content

Commit

Permalink
Merge pull request #126 from parallaxinc/patch-api-doc
Browse files Browse the repository at this point in the history
Update element documentation for load-prop message
  • Loading branch information
PropGit authored Sep 17, 2020
2 parents 3a7260e + e85068e commit 5563bbf
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ When the websocket is established, this message initializes the channel that all
with the APU will use.

### Message elements
**type** - Message name. (**Required**)
**type** - Message name, "hello-browser". (**Required**)

**baud** - Select a baud rate that the BlocklyProp Launcher will use to communicate with attached Propeller device(s). (Optional)
**baud** - Select a baud rate that the BlocklyProp Launcher will use to communicate with attached Propeller device(s).The default value is 115200. (Optional)

Note that there is another setting specific to the terminal baud rate in the <a href="#serial-terminal-message">serial-terminal</a> message.
```json
Expand Down Expand Up @@ -71,6 +71,10 @@ Propeller device, storing the app in either RAM or EEPROM (which is really RAM &

**portPath** - target port's name (direct from the port drop-down list); wired or wireless port. (**Required**)

_Needs Review:_

_The portPath value can be any of the following; 'enumerated port name from the client's OS', 'The wireless SSID', or 'wired'? Not sure about that and loadPropeller() is equally ambiguous._

**payload** - A base-64 encoded .elf, .binary, or .eeprom data containing the Propeller Application image. (**Required**)

**debug** - set to 'true' if a terminal is intended to connect to the Propeller after download, otherwise set to false. Default is false. (Optional)
Expand Down

0 comments on commit 5563bbf

Please sign in to comment.