Skip to content

Commit 5563bbf

Browse files
authored
Merge pull request #126 from parallaxinc/patch-api-doc
Update element documentation for load-prop message
2 parents 3a7260e + e85068e commit 5563bbf

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

API.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ When the websocket is established, this message initializes the channel that all
1515
with the APU will use.
1616

1717
### Message elements
18-
**type** - Message name. (**Required**)
18+
**type** - Message name, "hello-browser". (**Required**)
1919

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

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

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

74+
_Needs Review:_
75+
76+
_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._
77+
7478
**payload** - A base-64 encoded .elf, .binary, or .eeprom data containing the Propeller Application image. (**Required**)
7579

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

0 commit comments

Comments
 (0)