openc3-cosmos-bridge-serial 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.txt +695 -0
  3. data/README.md +22 -0
  4. data/Rakefile +12 -0
  5. data/bridge.txt +41 -0
  6. metadata +49 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f20a28499c4db5d2fa874348b7f87ecd243bf0ebf944605d77e2aa6f3dc923b6
4
+ data.tar.gz: abb3b38c27dc425bc8503711caa239cee9c25d27a0f5dec36e1d9f2ae104bcd9
5
+ SHA512:
6
+ metadata.gz: 3824c1d3a5a9d28a1a236be6ff1b5e6221cd26d6836c4d14717df0561d22c9eacc86734e5441abebdb6e476618ad8fb5541b40b6bd0ea9578e536a7cd50f54b0
7
+ data.tar.gz: dbf5f4fbbb2cb1be105691722cee2d4cd373c5f181fcf9501b9bcf33085fb2ded08fe807c1651cfda325e24ac9806522d8fa198749bb89b427c7434d6b9a6a03
data/LICENSE.txt ADDED
@@ -0,0 +1,695 @@
1
+ The OpenC3 COSMOS Dual License -- OpenC3 Only
2
+
3
+ The OpenC3 COSMOS software program is licensed under the
4
+ GNU Affero General Public License, version 3 with the Addendums listed below or
5
+ via Commercial licensing if purchased from OpenC3, Inc.
6
+
7
+ Please note that the verbiage of the AGPL below are copyrighted
8
+ by the Free Software Foundation, but the instance of code to which the
9
+ licenses refer (the OpenC3 COSMOS software) is copyrighted by
10
+ OpenC3 Inc. as marked in each file.
11
+
12
+ Also please note that the only valid versions of the AGPL
13
+ that pertain to OpenC3 COSMOS are the particular versions of
14
+ the license reproduced below (i.e., versions 3, rather than any other
15
+ versions of the AGPL), unless explicitly otherwise stated.
16
+
17
+ OpenC3 AGPL, version 3 LICENSE ADDENDUMS
18
+ OpenC3 COSMOS Version 5, 16 July 2022
19
+
20
+ The following addendums are made under section 7 of the GNU Affero General
21
+ Public License, version 3.
22
+
23
+ 1. The OpenC3, Inc. copyright and legal notices
24
+ on all user interfaces and source files must be preserved or
25
+ duplicated on any derivative works.
26
+ 2. Modified applications and source files must be clearly marked as
27
+ "modified" with the modification author and company indicated
28
+ immediately following the copyright and legal notices.
29
+ 3. OpenC3, and OpenC3 COSMOS are trademarks of OpenC3, Inc. and may be used for publicity purposes
30
+ only in a manner that constitutes "fair use" under applicable trademark
31
+ law, except with the express, written permission of OpenC3 Inc.
32
+
33
+ The AGPL license text follows:
34
+
35
+ GNU AFFERO GENERAL PUBLIC LICENSE
36
+ Version 3, 19 November 2007
37
+
38
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
39
+ Everyone is permitted to copy and distribute verbatim copies
40
+ of this license document, but changing it is not allowed.
41
+
42
+ Preamble
43
+
44
+ The GNU Affero General Public License is a free, copyleft license for
45
+ software and other kinds of works, specifically designed to ensure
46
+ cooperation with the community in the case of network server software.
47
+
48
+ The licenses for most software and other practical works are designed
49
+ to take away your freedom to share and change the works. By contrast,
50
+ our General Public Licenses are intended to guarantee your freedom to
51
+ share and change all versions of a program--to make sure it remains free
52
+ software for all its users.
53
+
54
+ When we speak of free software, we are referring to freedom, not
55
+ price. Our General Public Licenses are designed to make sure that you
56
+ have the freedom to distribute copies of free software (and charge for
57
+ them if you wish), that you receive source code or can get it if you
58
+ want it, that you can change the software or use pieces of it in new
59
+ free programs, and that you know you can do these things.
60
+
61
+ Developers that use our General Public Licenses protect your rights
62
+ with two steps: (1) assert copyright on the software, and (2) offer
63
+ you this License which gives you legal permission to copy, distribute
64
+ and/or modify the software.
65
+
66
+ A secondary benefit of defending all users' freedom is that
67
+ improvements made in alternate versions of the program, if they
68
+ receive widespread use, become available for other developers to
69
+ incorporate. Many developers of free software are heartened and
70
+ encouraged by the resulting cooperation. However, in the case of
71
+ software used on network servers, this result may fail to come about.
72
+ The GNU General Public License permits making a modified version and
73
+ letting the public access it on a server without ever releasing its
74
+ source code to the public.
75
+
76
+ The GNU Affero General Public License is designed specifically to
77
+ ensure that, in such cases, the modified source code becomes available
78
+ to the community. It requires the operator of a network server to
79
+ provide the source code of the modified version running there to the
80
+ users of that server. Therefore, public use of a modified version, on
81
+ a publicly accessible server, gives the public access to the source
82
+ code of the modified version.
83
+
84
+ An older license, called the Affero General Public License and
85
+ published by Affero, was designed to accomplish similar goals. This is
86
+ a different license, not a version of the Affero GPL, but Affero has
87
+ released a new version of the Affero GPL which permits relicensing under
88
+ this license.
89
+
90
+ The precise terms and conditions for copying, distribution and
91
+ modification follow.
92
+
93
+ TERMS AND CONDITIONS
94
+
95
+ 0. Definitions.
96
+
97
+ "This License" refers to version 3 of the GNU Affero General Public License.
98
+
99
+ "Copyright" also means copyright-like laws that apply to other kinds of
100
+ works, such as semiconductor masks.
101
+
102
+ "The Program" refers to any copyrightable work licensed under this
103
+ License. Each licensee is addressed as "you". "Licensees" and
104
+ "recipients" may be individuals or organizations.
105
+
106
+ To "modify" a work means to copy from or adapt all or part of the work
107
+ in a fashion requiring copyright permission, other than the making of an
108
+ exact copy. The resulting work is called a "modified version" of the
109
+ earlier work or a work "based on" the earlier work.
110
+
111
+ A "covered work" means either the unmodified Program or a work based
112
+ on the Program.
113
+
114
+ To "propagate" a work means to do anything with it that, without
115
+ permission, would make you directly or secondarily liable for
116
+ infringement under applicable copyright law, except executing it on a
117
+ computer or modifying a private copy. Propagation includes copying,
118
+ distribution (with or without modification), making available to the
119
+ public, and in some countries other activities as well.
120
+
121
+ To "convey" a work means any kind of propagation that enables other
122
+ parties to make or receive copies. Mere interaction with a user through
123
+ a computer network, with no transfer of a copy, is not conveying.
124
+
125
+ An interactive user interface displays "Appropriate Legal Notices"
126
+ to the extent that it includes a convenient and prominently visible
127
+ feature that (1) displays an appropriate copyright notice, and (2)
128
+ tells the user that there is no warranty for the work (except to the
129
+ extent that warranties are provided), that licensees may convey the
130
+ work under this License, and how to view a copy of this License. If
131
+ the interface presents a list of user commands or options, such as a
132
+ menu, a prominent item in the list meets this criterion.
133
+
134
+ 1. Source Code.
135
+
136
+ The "source code" for a work means the preferred form of the work
137
+ for making modifications to it. "Object code" means any non-source
138
+ form of a work.
139
+
140
+ A "Standard Interface" means an interface that either is an official
141
+ standard defined by a recognized standards body, or, in the case of
142
+ interfaces specified for a particular programming language, one that
143
+ is widely used among developers working in that language.
144
+
145
+ The "System Libraries" of an executable work include anything, other
146
+ than the work as a whole, that (a) is included in the normal form of
147
+ packaging a Major Component, but which is not part of that Major
148
+ Component, and (b) serves only to enable use of the work with that
149
+ Major Component, or to implement a Standard Interface for which an
150
+ implementation is available to the public in source code form. A
151
+ "Major Component", in this context, means a major essential component
152
+ (kernel, window system, and so on) of the specific operating system
153
+ (if any) on which the executable work runs, or a compiler used to
154
+ produce the work, or an object code interpreter used to run it.
155
+
156
+ The "Corresponding Source" for a work in object code form means all
157
+ the source code needed to generate, install, and (for an executable
158
+ work) run the object code and to modify the work, including scripts to
159
+ control those activities. However, it does not include the work's
160
+ System Libraries, or general-purpose tools or generally available free
161
+ programs which are used unmodified in performing those activities but
162
+ which are not part of the work. For example, Corresponding Source
163
+ includes interface definition files associated with source files for
164
+ the work, and the source code for shared libraries and dynamically
165
+ linked subprograms that the work is specifically designed to require,
166
+ such as by intimate data communication or control flow between those
167
+ subprograms and other parts of the work.
168
+
169
+ The Corresponding Source need not include anything that users
170
+ can regenerate automatically from other parts of the Corresponding
171
+ Source.
172
+
173
+ The Corresponding Source for a work in source code form is that
174
+ same work.
175
+
176
+ 2. Basic Permissions.
177
+
178
+ All rights granted under this License are granted for the term of
179
+ copyright on the Program, and are irrevocable provided the stated
180
+ conditions are met. This License explicitly affirms your unlimited
181
+ permission to run the unmodified Program. The output from running a
182
+ covered work is covered by this License only if the output, given its
183
+ content, constitutes a covered work. This License acknowledges your
184
+ rights of fair use or other equivalent, as provided by copyright law.
185
+
186
+ You may make, run and propagate covered works that you do not
187
+ convey, without conditions so long as your license otherwise remains
188
+ in force. You may convey covered works to others for the sole purpose
189
+ of having them make modifications exclusively for you, or provide you
190
+ with facilities for running those works, provided that you comply with
191
+ the terms of this License in conveying all material for which you do
192
+ not control copyright. Those thus making or running the covered works
193
+ for you must do so exclusively on your behalf, under your direction
194
+ and control, on terms that prohibit them from making any copies of
195
+ your copyrighted material outside their relationship with you.
196
+
197
+ Conveying under any other circumstances is permitted solely under
198
+ the conditions stated below. Sublicensing is not allowed; section 10
199
+ makes it unnecessary.
200
+
201
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
202
+
203
+ No covered work shall be deemed part of an effective technological
204
+ measure under any applicable law fulfilling obligations under article
205
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
206
+ similar laws prohibiting or restricting circumvention of such
207
+ measures.
208
+
209
+ When you convey a covered work, you waive any legal power to forbid
210
+ circumvention of technological measures to the extent such circumvention
211
+ is effected by exercising rights under this License with respect to
212
+ the covered work, and you disclaim any intention to limit operation or
213
+ modification of the work as a means of enforcing, against the work's
214
+ users, your or third parties' legal rights to forbid circumvention of
215
+ technological measures.
216
+
217
+ 4. Conveying Verbatim Copies.
218
+
219
+ You may convey verbatim copies of the Program's source code as you
220
+ receive it, in any medium, provided that you conspicuously and
221
+ appropriately publish on each copy an appropriate copyright notice;
222
+ keep intact all notices stating that this License and any
223
+ non-permissive terms added in accord with section 7 apply to the code;
224
+ keep intact all notices of the absence of any warranty; and give all
225
+ recipients a copy of this License along with the Program.
226
+
227
+ You may charge any price or no price for each copy that you convey,
228
+ and you may offer support or warranty protection for a fee.
229
+
230
+ 5. Conveying Modified Source Versions.
231
+
232
+ You may convey a work based on the Program, or the modifications to
233
+ produce it from the Program, in the form of source code under the
234
+ terms of section 4, provided that you also meet all of these conditions:
235
+
236
+ a) The work must carry prominent notices stating that you modified
237
+ it, and giving a relevant date.
238
+
239
+ b) The work must carry prominent notices stating that it is
240
+ released under this License and any conditions added under section
241
+ 7. This requirement modifies the requirement in section 4 to
242
+ "keep intact all notices".
243
+
244
+ c) You must license the entire work, as a whole, under this
245
+ License to anyone who comes into possession of a copy. This
246
+ License will therefore apply, along with any applicable section 7
247
+ additional terms, to the whole of the work, and all its parts,
248
+ regardless of how they are packaged. This License gives no
249
+ permission to license the work in any other way, but it does not
250
+ invalidate such permission if you have separately received it.
251
+
252
+ d) If the work has interactive user interfaces, each must display
253
+ Appropriate Legal Notices; however, if the Program has interactive
254
+ interfaces that do not display Appropriate Legal Notices, your
255
+ work need not make them do so.
256
+
257
+ A compilation of a covered work with other separate and independent
258
+ works, which are not by their nature extensions of the covered work,
259
+ and which are not combined with it such as to form a larger program,
260
+ in or on a volume of a storage or distribution medium, is called an
261
+ "aggregate" if the compilation and its resulting copyright are not
262
+ used to limit the access or legal rights of the compilation's users
263
+ beyond what the individual works permit. Inclusion of a covered work
264
+ in an aggregate does not cause this License to apply to the other
265
+ parts of the aggregate.
266
+
267
+ 6. Conveying Non-Source Forms.
268
+
269
+ You may convey a covered work in object code form under the terms
270
+ of sections 4 and 5, provided that you also convey the
271
+ machine-readable Corresponding Source under the terms of this License,
272
+ in one of these ways:
273
+
274
+ a) Convey the object code in, or embodied in, a physical product
275
+ (including a physical distribution medium), accompanied by the
276
+ Corresponding Source fixed on a durable physical medium
277
+ customarily used for software interchange.
278
+
279
+ b) Convey the object code in, or embodied in, a physical product
280
+ (including a physical distribution medium), accompanied by a
281
+ written offer, valid for at least three years and valid for as
282
+ long as you offer spare parts or customer support for that product
283
+ model, to give anyone who possesses the object code either (1) a
284
+ copy of the Corresponding Source for all the software in the
285
+ product that is covered by this License, on a durable physical
286
+ medium customarily used for software interchange, for a price no
287
+ more than your reasonable cost of physically performing this
288
+ conveying of source, or (2) access to copy the
289
+ Corresponding Source from a network server at no charge.
290
+
291
+ c) Convey individual copies of the object code with a copy of the
292
+ written offer to provide the Corresponding Source. This
293
+ alternative is allowed only occasionally and noncommercially, and
294
+ only if you received the object code with such an offer, in accord
295
+ with subsection 6b.
296
+
297
+ d) Convey the object code by offering access from a designated
298
+ place (gratis or for a charge), and offer equivalent access to the
299
+ Corresponding Source in the same way through the same place at no
300
+ further charge. You need not require recipients to copy the
301
+ Corresponding Source along with the object code. If the place to
302
+ copy the object code is a network server, the Corresponding Source
303
+ may be on a different server (operated by you or a third party)
304
+ that supports equivalent copying facilities, provided you maintain
305
+ clear directions next to the object code saying where to find the
306
+ Corresponding Source. Regardless of what server hosts the
307
+ Corresponding Source, you remain obligated to ensure that it is
308
+ available for as long as needed to satisfy these requirements.
309
+
310
+ e) Convey the object code using peer-to-peer transmission, provided
311
+ you inform other peers where the object code and Corresponding
312
+ Source of the work are being offered to the general public at no
313
+ charge under subsection 6d.
314
+
315
+ A separable portion of the object code, whose source code is excluded
316
+ from the Corresponding Source as a System Library, need not be
317
+ included in conveying the object code work.
318
+
319
+ A "User Product" is either (1) a "consumer product", which means any
320
+ tangible personal property which is normally used for personal, family,
321
+ or household purposes, or (2) anything designed or sold for incorporation
322
+ into a dwelling. In determining whether a product is a consumer product,
323
+ doubtful cases shall be resolved in favor of coverage. For a particular
324
+ product received by a particular user, "normally used" refers to a
325
+ typical or common use of that class of product, regardless of the status
326
+ of the particular user or of the way in which the particular user
327
+ actually uses, or expects or is expected to use, the product. A product
328
+ is a consumer product regardless of whether the product has substantial
329
+ commercial, industrial or non-consumer uses, unless such uses represent
330
+ the only significant mode of use of the product.
331
+
332
+ "Installation Information" for a User Product means any methods,
333
+ procedures, authorization keys, or other information required to install
334
+ and execute modified versions of a covered work in that User Product from
335
+ a modified version of its Corresponding Source. The information must
336
+ suffice to ensure that the continued functioning of the modified object
337
+ code is in no case prevented or interfered with solely because
338
+ modification has been made.
339
+
340
+ If you convey an object code work under this section in, or with, or
341
+ specifically for use in, a User Product, and the conveying occurs as
342
+ part of a transaction in which the right of possession and use of the
343
+ User Product is transferred to the recipient in perpetuity or for a
344
+ fixed term (regardless of how the transaction is characterized), the
345
+ Corresponding Source conveyed under this section must be accompanied
346
+ by the Installation Information. But this requirement does not apply
347
+ if neither you nor any third party retains the ability to install
348
+ modified object code on the User Product (for example, the work has
349
+ been installed in ROM).
350
+
351
+ The requirement to provide Installation Information does not include a
352
+ requirement to continue to provide support service, warranty, or updates
353
+ for a work that has been modified or installed by the recipient, or for
354
+ the User Product in which it has been modified or installed. Access to a
355
+ network may be denied when the modification itself materially and
356
+ adversely affects the operation of the network or violates the rules and
357
+ protocols for communication across the network.
358
+
359
+ Corresponding Source conveyed, and Installation Information provided,
360
+ in accord with this section must be in a format that is publicly
361
+ documented (and with an implementation available to the public in
362
+ source code form), and must require no special password or key for
363
+ unpacking, reading or copying.
364
+
365
+ 7. Additional Terms.
366
+
367
+ "Additional permissions" are terms that supplement the terms of this
368
+ License by making exceptions from one or more of its conditions.
369
+ Additional permissions that are applicable to the entire Program shall
370
+ be treated as though they were included in this License, to the extent
371
+ that they are valid under applicable law. If additional permissions
372
+ apply only to part of the Program, that part may be used separately
373
+ under those permissions, but the entire Program remains governed by
374
+ this License without regard to the additional permissions.
375
+
376
+ When you convey a copy of a covered work, you may at your option
377
+ remove any additional permissions from that copy, or from any part of
378
+ it. (Additional permissions may be written to require their own
379
+ removal in certain cases when you modify the work.) You may place
380
+ additional permissions on material, added by you to a covered work,
381
+ for which you have or can give appropriate copyright permission.
382
+
383
+ Notwithstanding any other provision of this License, for material you
384
+ add to a covered work, you may (if authorized by the copyright holders of
385
+ that material) supplement the terms of this License with terms:
386
+
387
+ a) Disclaiming warranty or limiting liability differently from the
388
+ terms of sections 15 and 16 of this License; or
389
+
390
+ b) Requiring preservation of specified reasonable legal notices or
391
+ author attributions in that material or in the Appropriate Legal
392
+ Notices displayed by works containing it; or
393
+
394
+ c) Prohibiting misrepresentation of the origin of that material, or
395
+ requiring that modified versions of such material be marked in
396
+ reasonable ways as different from the original version; or
397
+
398
+ d) Limiting the use for publicity purposes of names of licensors or
399
+ authors of the material; or
400
+
401
+ e) Declining to grant rights under trademark law for use of some
402
+ trade names, trademarks, or service marks; or
403
+
404
+ f) Requiring indemnification of licensors and authors of that
405
+ material by anyone who conveys the material (or modified versions of
406
+ it) with contractual assumptions of liability to the recipient, for
407
+ any liability that these contractual assumptions directly impose on
408
+ those licensors and authors.
409
+
410
+ All other non-permissive additional terms are considered "further
411
+ restrictions" within the meaning of section 10. If the Program as you
412
+ received it, or any part of it, contains a notice stating that it is
413
+ governed by this License along with a term that is a further
414
+ restriction, you may remove that term. If a license document contains
415
+ a further restriction but permits relicensing or conveying under this
416
+ License, you may add to a covered work material governed by the terms
417
+ of that license document, provided that the further restriction does
418
+ not survive such relicensing or conveying.
419
+
420
+ If you add terms to a covered work in accord with this section, you
421
+ must place, in the relevant source files, a statement of the
422
+ additional terms that apply to those files, or a notice indicating
423
+ where to find the applicable terms.
424
+
425
+ Additional terms, permissive or non-permissive, may be stated in the
426
+ form of a separately written license, or stated as exceptions;
427
+ the above requirements apply either way.
428
+
429
+ 8. Termination.
430
+
431
+ You may not propagate or modify a covered work except as expressly
432
+ provided under this License. Any attempt otherwise to propagate or
433
+ modify it is void, and will automatically terminate your rights under
434
+ this License (including any patent licenses granted under the third
435
+ paragraph of section 11).
436
+
437
+ However, if you cease all violation of this License, then your
438
+ license from a particular copyright holder is reinstated (a)
439
+ provisionally, unless and until the copyright holder explicitly and
440
+ finally terminates your license, and (b) permanently, if the copyright
441
+ holder fails to notify you of the violation by some reasonable means
442
+ prior to 60 days after the cessation.
443
+
444
+ Moreover, your license from a particular copyright holder is
445
+ reinstated permanently if the copyright holder notifies you of the
446
+ violation by some reasonable means, this is the first time you have
447
+ received notice of violation of this License (for any work) from that
448
+ copyright holder, and you cure the violation prior to 30 days after
449
+ your receipt of the notice.
450
+
451
+ Termination of your rights under this section does not terminate the
452
+ licenses of parties who have received copies or rights from you under
453
+ this License. If your rights have been terminated and not permanently
454
+ reinstated, you do not qualify to receive new licenses for the same
455
+ material under section 10.
456
+
457
+ 9. Acceptance Not Required for Having Copies.
458
+
459
+ You are not required to accept this License in order to receive or
460
+ run a copy of the Program. Ancillary propagation of a covered work
461
+ occurring solely as a consequence of using peer-to-peer transmission
462
+ to receive a copy likewise does not require acceptance. However,
463
+ nothing other than this License grants you permission to propagate or
464
+ modify any covered work. These actions infringe copyright if you do
465
+ not accept this License. Therefore, by modifying or propagating a
466
+ covered work, you indicate your acceptance of this License to do so.
467
+
468
+ 10. Automatic Licensing of Downstream Recipients.
469
+
470
+ Each time you convey a covered work, the recipient automatically
471
+ receives a license from the original licensors, to run, modify and
472
+ propagate that work, subject to this License. You are not responsible
473
+ for enforcing compliance by third parties with this License.
474
+
475
+ An "entity transaction" is a transaction transferring control of an
476
+ organization, or substantially all assets of one, or subdividing an
477
+ organization, or merging organizations. If propagation of a covered
478
+ work results from an entity transaction, each party to that
479
+ transaction who receives a copy of the work also receives whatever
480
+ licenses to the work the party's predecessor in interest had or could
481
+ give under the previous paragraph, plus a right to possession of the
482
+ Corresponding Source of the work from the predecessor in interest, if
483
+ the predecessor has it or can get it with reasonable efforts.
484
+
485
+ You may not impose any further restrictions on the exercise of the
486
+ rights granted or affirmed under this License. For example, you may
487
+ not impose a license fee, royalty, or other charge for exercise of
488
+ rights granted under this License, and you may not initiate litigation
489
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
490
+ any patent claim is infringed by making, using, selling, offering for
491
+ sale, or importing the Program or any portion of it.
492
+
493
+ 11. Patents.
494
+
495
+ A "contributor" is a copyright holder who authorizes use under this
496
+ License of the Program or a work on which the Program is based. The
497
+ work thus licensed is called the contributor's "contributor version".
498
+
499
+ A contributor's "essential patent claims" are all patent claims
500
+ owned or controlled by the contributor, whether already acquired or
501
+ hereafter acquired, that would be infringed by some manner, permitted
502
+ by this License, of making, using, or selling its contributor version,
503
+ but do not include claims that would be infringed only as a
504
+ consequence of further modification of the contributor version. For
505
+ purposes of this definition, "control" includes the right to grant
506
+ patent sublicenses in a manner consistent with the requirements of
507
+ this License.
508
+
509
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
510
+ patent license under the contributor's essential patent claims, to
511
+ make, use, sell, offer for sale, import and otherwise run, modify and
512
+ propagate the contents of its contributor version.
513
+
514
+ In the following three paragraphs, a "patent license" is any express
515
+ agreement or commitment, however denominated, not to enforce a patent
516
+ (such as an express permission to practice a patent or covenant not to
517
+ sue for patent infringement). To "grant" such a patent license to a
518
+ party means to make such an agreement or commitment not to enforce a
519
+ patent against the party.
520
+
521
+ If you convey a covered work, knowingly relying on a patent license,
522
+ and the Corresponding Source of the work is not available for anyone
523
+ to copy, free of charge and under the terms of this License, through a
524
+ publicly available network server or other readily accessible means,
525
+ then you must either (1) cause the Corresponding Source to be so
526
+ available, or (2) arrange to deprive yourself of the benefit of the
527
+ patent license for this particular work, or (3) arrange, in a manner
528
+ consistent with the requirements of this License, to extend the patent
529
+ license to downstream recipients. "Knowingly relying" means you have
530
+ actual knowledge that, but for the patent license, your conveying the
531
+ covered work in a country, or your recipient's use of the covered work
532
+ in a country, would infringe one or more identifiable patents in that
533
+ country that you have reason to believe are valid.
534
+
535
+ If, pursuant to or in connection with a single transaction or
536
+ arrangement, you convey, or propagate by procuring conveyance of, a
537
+ covered work, and grant a patent license to some of the parties
538
+ receiving the covered work authorizing them to use, propagate, modify
539
+ or convey a specific copy of the covered work, then the patent license
540
+ you grant is automatically extended to all recipients of the covered
541
+ work and works based on it.
542
+
543
+ A patent license is "discriminatory" if it does not include within
544
+ the scope of its coverage, prohibits the exercise of, or is
545
+ conditioned on the non-exercise of one or more of the rights that are
546
+ specifically granted under this License. You may not convey a covered
547
+ work if you are a party to an arrangement with a third party that is
548
+ in the business of distributing software, under which you make payment
549
+ to the third party based on the extent of your activity of conveying
550
+ the work, and under which the third party grants, to any of the
551
+ parties who would receive the covered work from you, a discriminatory
552
+ patent license (a) in connection with copies of the covered work
553
+ conveyed by you (or copies made from those copies), or (b) primarily
554
+ for and in connection with specific products or compilations that
555
+ contain the covered work, unless you entered into that arrangement,
556
+ or that patent license was granted, prior to 28 March 2007.
557
+
558
+ Nothing in this License shall be construed as excluding or limiting
559
+ any implied license or other defenses to infringement that may
560
+ otherwise be available to you under applicable patent law.
561
+
562
+ 12. No Surrender of Others' Freedom.
563
+
564
+ If conditions are imposed on you (whether by court order, agreement or
565
+ otherwise) that contradict the conditions of this License, they do not
566
+ excuse you from the conditions of this License. If you cannot convey a
567
+ covered work so as to satisfy simultaneously your obligations under this
568
+ License and any other pertinent obligations, then as a consequence you may
569
+ not convey it at all. For example, if you agree to terms that obligate you
570
+ to collect a royalty for further conveying from those to whom you convey
571
+ the Program, the only way you could satisfy both those terms and this
572
+ License would be to refrain entirely from conveying the Program.
573
+
574
+ 13. Remote Network Interaction; Use with the GNU General Public License.
575
+
576
+ Notwithstanding any other provision of this License, if you modify the
577
+ Program, your modified version must prominently offer all users
578
+ interacting with it remotely through a computer network (if your version
579
+ supports such interaction) an opportunity to receive the Corresponding
580
+ Source of your version by providing access to the Corresponding Source
581
+ from a network server at no charge, through some standard or customary
582
+ means of facilitating copying of software. This Corresponding Source
583
+ shall include the Corresponding Source for any work covered by version 3
584
+ of the GNU General Public License that is incorporated pursuant to the
585
+ following paragraph.
586
+
587
+ Notwithstanding any other provision of this License, you have
588
+ permission to link or combine any covered work with a work licensed
589
+ under version 3 of the GNU General Public License into a single
590
+ combined work, and to convey the resulting work. The terms of this
591
+ License will continue to apply to the part which is the covered work,
592
+ but the work with which it is combined will remain governed by version
593
+ 3 of the GNU General Public License.
594
+
595
+ 14. Revised Versions of this License.
596
+
597
+ The Free Software Foundation may publish revised and/or new versions of
598
+ the GNU Affero General Public License from time to time. Such new versions
599
+ will be similar in spirit to the present version, but may differ in detail to
600
+ address new problems or concerns.
601
+
602
+ Each version is given a distinguishing version number. If the
603
+ Program specifies that a certain numbered version of the GNU Affero General
604
+ Public License "or any later version" applies to it, you have the
605
+ option of following the terms and conditions either of that numbered
606
+ version or of any later version published by the Free Software
607
+ Foundation. If the Program does not specify a version number of the
608
+ GNU Affero General Public License, you may choose any version ever published
609
+ by the Free Software Foundation.
610
+
611
+ If the Program specifies that a proxy can decide which future
612
+ versions of the GNU Affero General Public License can be used, that proxy's
613
+ public statement of acceptance of a version permanently authorizes you
614
+ to choose that version for the Program.
615
+
616
+ Later license versions may give you additional or different
617
+ permissions. However, no additional obligations are imposed on any
618
+ author or copyright holder as a result of your choosing to follow a
619
+ later version.
620
+
621
+ 15. Disclaimer of Warranty.
622
+
623
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
624
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
625
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
626
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
627
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
628
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
629
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
630
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
631
+
632
+ 16. Limitation of Liability.
633
+
634
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
635
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
636
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
637
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
638
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
639
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
640
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
641
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
642
+ SUCH DAMAGES.
643
+
644
+ 17. Interpretation of Sections 15 and 16.
645
+
646
+ If the disclaimer of warranty and limitation of liability provided
647
+ above cannot be given local legal effect according to their terms,
648
+ reviewing courts shall apply local law that most closely approximates
649
+ an absolute waiver of all civil liability in connection with the
650
+ Program, unless a warranty or assumption of liability accompanies a
651
+ copy of the Program in return for a fee.
652
+
653
+ END OF TERMS AND CONDITIONS
654
+
655
+ How to Apply These Terms to Your New Programs
656
+
657
+ If you develop a new program, and you want it to be of the greatest
658
+ possible use to the public, the best way to achieve this is to make it
659
+ free software which everyone can redistribute and change under these terms.
660
+
661
+ To do so, attach the following notices to the program. It is safest
662
+ to attach them to the start of each source file to most effectively
663
+ state the exclusion of warranty; and each file should have at least
664
+ the "copyright" line and a pointer to where the full notice is found.
665
+
666
+ <one line to give the program's name and a brief idea of what it does.>
667
+ Copyright (C) <year> <name of author>
668
+
669
+ This program is free software: you can redistribute it and/or modify
670
+ it under the terms of the GNU Affero General Public License as published
671
+ by the Free Software Foundation, either version 3 of the License, or
672
+ (at your option) any later version.
673
+
674
+ This program is distributed in the hope that it will be useful,
675
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
676
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
677
+ GNU Affero General Public License for more details.
678
+
679
+ You should have received a copy of the GNU Affero General Public License
680
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
681
+
682
+ Also add information on how to contact you by electronic and paper mail.
683
+
684
+ If your software can interact with users remotely through a computer
685
+ network, you should also make sure that it provides a way for users to
686
+ get its source. For example, if your program is a web application, its
687
+ interface could display a "Source" link that leads users to an archive
688
+ of the code. There are many ways you could offer source, and different
689
+ solutions will be better for different programs; see section 13 for the
690
+ specific requirements.
691
+
692
+ You should also get your employer (if you work as a programmer) or school,
693
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
694
+ For more information on this, and how to apply and follow the GNU AGPL, see
695
+ <http://www.gnu.org/licenses/>.
data/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # OpenC3 COSMOS Bridge for Serial Connections
2
+
3
+ This bridge provides an interface to connect to a host's serial port and forward the
4
+ data to COSMOS over TCP/IP.
5
+
6
+ ## Install and Run the Bridge
7
+
8
+ 1. gem install openc3
9
+ 1. gem install openc3-cosmos-bridge-serial
10
+ 1. Update the next step with your specific serial port settings
11
+ 1. openc3cli bridgegem openc3-cosmos-bridge-serial router_port=2950 write_port_name=COM1 read_port_name=COM1 baud_rate=115200 parity=ODD
12
+
13
+ ## Create and Install a Plugin
14
+
15
+ You will also need to create a COSMOS plugin that describes your target and connects to the bridge.
16
+
17
+ The INTERFACE section of your plugin will look something like this:
18
+
19
+ ```
20
+ INTERFACE BRIDGE_INT tcpip_client_interface.rb host.docker.internal 2950 2950 10.0 nil LENGTH [Protocol Specific Parameters]
21
+ MAP_TARGET MY_TARGET
22
+ ```
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ PLUGIN_NAME = Dir['*.gemspec'][0].split('.')[0..-2].join('.')
2
+
3
+ task :require_version do
4
+ unless ENV['VERSION']
5
+ puts "VERSION is required: rake build VERSION=X.Y.Z"
6
+ exit 1
7
+ end
8
+ end
9
+
10
+ task :build => [:require_version] do
11
+ system("gem build #{PLUGIN_NAME}")
12
+ end
data/bridge.txt ADDED
@@ -0,0 +1,41 @@
1
+ # Write serial port name
2
+ VARIABLE write_port_name COM1
3
+
4
+ # Read serial port name
5
+ VARIABLE read_port_name COM1
6
+
7
+ # Baud Rate
8
+ VARIABLE baud_rate 115200
9
+
10
+ # Parity - NONE, ODD, or EVEN
11
+ VARIABLE parity NONE
12
+
13
+ # Stop bits - 0, 1, or 2
14
+ VARIABLE stop_bits 1
15
+
16
+ # Write Timeout
17
+ VARIABLE write_timeout 10.0
18
+
19
+ # Read Timeout
20
+ VARIABLE read_timeout nil
21
+
22
+ # Flow Control - NONE, or RTSCTS
23
+ VARIABLE flow_control NONE
24
+
25
+ # Data bits per word - Typically 8
26
+ VARIABLE data_bits 8
27
+
28
+ # Port to listen for connections from COSMOS - Plugin must match
29
+ VARIABLE router_port 2950
30
+
31
+ # Port to listen on for connections from COSMOS. Defaults to localhost for security. Will need to be opened
32
+ # if COSMOS is on another machine.
33
+ VARIABLE router_listen_address 127.0.0.1
34
+
35
+ INTERFACE SERIAL_INT serial_interface.rb <%= write_port_name %> <%= read_port_name %> <%= baud_rate %> <%= parity %> <%= stop_bits %> <%= write_timeout %> <%= read_timeout %>
36
+ OPTION FLOW_CONTROL <%= flow_control %>
37
+ OPTION DATA_BITS <%= data_bits %>
38
+
39
+ ROUTER SERIAL_ROUTER tcpip_server_interface.rb <%= router_port %> <%= router_port %> 10.0 nil BURST
40
+ ROUTE SERIAL_INT
41
+ OPTION LISTEN_ADDRESS <%= router_listen_address %>
metadata ADDED
@@ -0,0 +1,49 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: openc3-cosmos-bridge-serial
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Ryan Melton
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2023-03-22 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: " This bridge provides an interface to connect to a host's serial
14
+ port and forward the data to COSMOS over TCP/IP.\n"
15
+ email:
16
+ - ryan@openc3.com
17
+ executables: []
18
+ extensions: []
19
+ extra_rdoc_files: []
20
+ files:
21
+ - LICENSE.txt
22
+ - README.md
23
+ - Rakefile
24
+ - bridge.txt
25
+ homepage: https://github.com/OpenC3/openc3
26
+ licenses:
27
+ - AGPL-3.0-only
28
+ - Nonstandard
29
+ metadata: {}
30
+ post_install_message:
31
+ rdoc_options: []
32
+ require_paths:
33
+ - lib
34
+ required_ruby_version: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - ">="
37
+ - !ruby/object:Gem::Version
38
+ version: '0'
39
+ required_rubygems_version: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: '0'
44
+ requirements: []
45
+ rubygems_version: 3.3.26
46
+ signing_key:
47
+ specification_version: 4
48
+ summary: OpenC3 openc3-cosmos-bridge-serial
49
+ test_files: []