Skip to content

Commit f3b1f93

Browse files
committed
update docs
1 parent 5e836c4 commit f3b1f93

File tree

3 files changed

+28
-43
lines changed

3 files changed

+28
-43
lines changed

README.md

+21-42
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ communications with the integrated serial monitor tool window.
1616
* Serial port monitor tool window with options to disconnect on build start and reconnect on
1717
build complete.
1818

19-
:warning: Build events are only available in CLion 2018.3 (or later) so these options are
20-
disabled if you are running an earlier version of CLion.
21-
2219
* Change current build parameters `Tools` > `Arduino Support` > `Change build settings`.
2320

2421
* Customize template files used for creating new projects.
@@ -35,12 +32,15 @@ communications with the integrated serial monitor tool window.
3532

3633
![Screenshot_ChangeBuildDiff](/assets/images/Screenshot_ChangeBuildDiff.png)
3734

38-
#### :warning: `Serial Port Monitor` plugin cannot be used with `Arduino Support`
35+
#### :warning: `Serial Port Monitor` plugin may conflict with `Arduino Support`
3936

40-
Both plugins use [jSSC-2.8.0] serial library and only one plugin can load the native libraries.
41-
Please uninstall or disable `Serial Port Monitor` plugin before installing `Arduino Support`.
37+
This plugin uses [Simple Serial Connector Service] plugin, which uses
38+
[jscc - Java Simple Serial Connector] serial library, as does `Serial Port Monitor` plugin. Only
39+
one plugin can load the native libraries. If you encounter conflicts please uninstall or disable
40+
`Serial Port Monitor` plugin, or this plugin.
4241

4342
## Uploading a sketch
43+
4444
Select the upload configuration from the dropdown. The type (debug/release) does not matter.
4545

4646
![select upload from dropdown](/assets/images/Screenshot_RunDebugConfiguration.png)
@@ -65,8 +65,8 @@ see if there are differences from the bundled version.
6565
The `Create From Bundled` button is only displayed when a non-existent directory is given and it
6666
can be created. Pressing it will create the directory and populate it with the bundled
6767
templates. For layout and caveats of this directory please refer to the
68-
[README.md](/resources/com/vladsch/clionarduinoplugin/templates/README.md)
69-
file in that directory.
68+
[README.md](/resources/com/vladsch/clionarduinoplugin/templates/README.md) file in that
69+
directory.
7070

7171
`On Disconnect Delay`, 50ms default. Introduces a short (0-100ms) delay before a build when
7272
disconnecting a port to allow the port to become available. On some projects with very short
@@ -81,40 +81,18 @@ Updated to work with CLion 2020.3 to 2023.1, with fixes in the ArduinoToolchain.
8181
Added an option not to use bundled toolchain file. This opens the possibility of using another
8282
toolchain.
8383

84+
Updated all native serial port code to [jscc - Java Simple Serial Connector] and moved code to
85+
[Simple Serial Connector Service] plugin to allow multiple plugins to provide serial port
86+
monitoring without conflicts on native libraries.
87+
8488
## Wish List
8589

86-
* [x] Convert to project wizard in new project as Arduino Sketch Project, instead of file menu
87-
item.
88-
* [x] Add Configuration options:
89-
* [x] Board selection
90-
* [x] CPU selection
91-
* [x] Port selection using jssc [jSSC-2.8.0] Patched for Arduino by Cristian Maglie
92-
https://raw.githubusercontent.com/arduino/Arduino/master/arduino-core/src/processing/app/SerialPortList.java
93-
* [x] Persistence for new project options, since these are most likely to be re-used.
94-
* [x] Allow additional Library directories
95-
* [x] User selectable boards.txt and programmers.txt location. By default the plugin will use
96-
embedded version of these files.
97-
* [x] Add: Serial Terminal tool window, current
98-
[`Serial Monitor` plugin](https://plugins.jetbrains.com/plugin/8031-serial-port-monitor)
99-
is functional but prevents JSSC native libraries from being used to list available ports,
100-
is not actively developed and lacks creature comforts:
101-
* [x] auto disconnect on project build so update build can connect to the board,
102-
* [x] reconnect after successful build is done
103-
* [x] recognize the enter key as send
104-
* [x] option to send individual keys as they are typed, with or without local echo, simulating
105-
a real serial
90+
* [x] Serial Terminal tool window
10691
* [ ] Add Hex pane in addition to text view. Either one or both could be displayed. With
10792
coordinated highlighting carets between the two. That way text view is not mangled into
10893
a block but naturally flows as you would expect, while hex view can be either a block or
10994
flow to match the text.
11095
* [ ] Display of ascii codes without resorting to hex display in text mode console.
111-
* [x] add CMake parser and builder to allow extracting and modifying CMake files
112-
programmatically, after project creation
113-
* [x] add option for using customized project templates
114-
* [x] add code for loading project options from CMakeLists.txt (for UI modification)
115-
* [x] Add UI for changing existing CMakeLists.txt configuration
116-
* [x] Change board, cpu, programmer, port, etc. All options which were available on project
117-
creation and make sense to modify on existing project.
11896
* [ ] Refactoring support which CLion does not handle:
11997
* [ ] Add file to sources or headers (CLion cannot make sense of the Arduino project file)
12098
* [ ] Add updating of `keywords.txt` when identifiers in source or headers are renamed.
@@ -126,19 +104,20 @@ toolchain.
126104

127105
## Release notes
128106

129-
[Version Notes](VERSION.md)
107+
[Version Notes]
130108

131109
## History
132110

133-
This plugin is a fork of
134-
[Original CLionArduinoPlugin](https://github.com/francoiscampbell/CLionArduinoPlugin) written by
135-
Francois Campbell.
111+
This plugin is a fork of [Original CLionArduinoPlugin] written by Francois Campbell.
136112

137113
## Notes
138114

139-
For serial port list and functionality the plugin uses [jSSC-2.8.0], Licensed under
140-
[GNU Lesser GPL]
115+
For serial port list and functionality the plugin uses [jscc - Java Simple Serial Connector],
116+
Licensed under [GNU Lesser GPL]
141117

142118
[GNU Lesser GPL]: http://www.gnu.org/licenses/lgpl.html
143-
[jSSC-2.8.0]: https://github.com/scream3r/java-simple-serial-connector
119+
[Version Notes]: VERSION.md
120+
[Original CLionArduinoPlugin]: https://github.com/francoiscampbell/CLionArduinoPlugin
121+
[Simple Serial Connector Service]: https://plugins.jetbrains.com/plugin/21550-simpleserialconnectorservice
122+
[jscc - Java Simple Serial Connector]: https://github.com/java-native/jssc
144123

VERSION.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
### Version History
66
- [CLionArduinoPlugin Version Notes](#clionarduinoplugin-version-notes)
77
- [TO DO](#to-do)
8+
- [1.5.39](#1539)
89
- [1.5.37](#1537)
910
- [1.5.35](#1535)
1011
- [1.5.33](#1533)
@@ -57,6 +58,10 @@
5758
* Add: inspection to check that `CMakeLists.txt` is out of sync, especially if missing the
5859
toolchain file.
5960

61+
### 1.5.39
62+
63+
* Change: to use `SerialPortOwnerAccess` instance for writing to port
64+
6065
### 1.5.37
6166

6267
* Change: extract all serial port comms with [java-simple-serial-connector] to a separate plugin

resources/META-INF/plugin.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@
5353
]]></description>
5454

5555
<change-notes><![CDATA[
56-
<h3>1.5.38</h3>
56+
<h3>1.5.40</h3>
5757
<ul>
58+
<li>Change: to use <code>SerialPortOwnerAccess</code> instance for writing to port</li>
5859
<li>Change: extract all serial port comms with <a href="https://github.com/scream3r/java-simple-serial-connector">java-simple-serial-connector</a> to a separate plugin
5960
exposing serial communications as a service:
6061
<a href="https://plugins.jetbrains.com/plugin/21550-simpleserialconnectorservice">SimpleSerialConnectorService</a>

0 commit comments

Comments
 (0)