Sfoglia il codice sorgente

initial import

master
Matthias Janke 5 anni fa
commit
c765eb4c92

+ 660
- 0
LICENSE.agpl-3.0.md Vedi File

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

+ 22
- 0
meson.build Vedi File

@@ -0,0 +1,22 @@
1
+project('RadAngel', 'cpp', default_options : ['cpp_std=c++17'], license : ['AGPL3','GPL3'], version : '0.1')
2
+
3
+thread_dep = dependency('threads')
4
+
5
+udev_dir = get_option('udev-dir')
6
+install_udev_dir = (udev_dir != 'no')
7
+
8
+if install_udev_dir and udev_dir == ''
9
+  udev_dir = dependency('udev').get_pkgconfig_variable('udevdir')
10
+endif
11
+
12
+systemd_unit_dir = get_option('systemd-unit-dir')
13
+install_systemd_unit_dir = (systemd_unit_dir != 'no')
14
+
15
+if install_systemd_unit_dir and systemd_unit_dir == ''
16
+  systemd_unit_dir = dependency('systemd').get_pkgconfig_variable('systemdsystemunitdir')
17
+endif
18
+
19
+subdir('radangeld')
20
+#subdir('radangel-webmon')
21
+#subdir('src')
22
+

+ 2
- 0
meson_options.txt Vedi File

@@ -0,0 +1,2 @@
1
+option('udev-dir', type: 'string', value: '', description: 'Absolute path of the udev base directory. Set to \'no\' not to install the udev rule')
2
+option('systemd-unit-dir', type: 'string', value: '', description: 'systemd service directory')

+ 676
- 0
radangeld/main.cpp Vedi File

@@ -0,0 +1,676 @@
1
+/*
2
+radangeld -- a linux daemon to readout and distribute data measured by a Kromek 
3
+RadAngel γ-spectrometer
4
+Copyright (C) 2019 Matthias Janke <matthias.janke@physi.uni-heidelberg.de>
5
+
6
+This program is free software: you can redistribute it and/or modify it under 
7
+the terms of the GNU Affero General Public License as published by the Free 
8
+Software Foundation, version 3.
9
+
10
+This program is distributed in the hope that it will be useful, but WITHOUT ANY 
11
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
12
+PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
13
+
14
+You should have received a copy of the GNU Affero General Public License along 
15
+with this program. If not, see <https://www.gnu.org/licenses/>
16
+*/
17
+// SPDX-License-Identifier: AGPL-3.0-only
18
+
19
+
20
+#include <iostream>
21
+#include <fstream>
22
+#include <chrono>
23
+#include <array>
24
+#include <limits>
25
+#include <thread>
26
+#include <atomic>
27
+#include <csignal>
28
+
29
+#include <wchar.h>
30
+
31
+// generate timestamps that are identifiable
32
+#include "date/tz.h"
33
+
34
+// program option parser
35
+#include <boost/program_options.hpp>
36
+
37
+// HID device access helper library
38
+#include <hidapi.h>
39
+
40
+// configuration file library
41
+#include <libconfig.h++>
42
+
43
+// thread/ipc/tcp communications
44
+#include <zmqpp/zmqpp.hpp>
45
+
46
+// systemd new-style daemon library
47
+#include <systemd/sd-daemon.h>
48
+
49
+namespace po = boost::program_options;
50
+
51
+namespace
52
+{
53
+  volatile std::sig_atomic_t terminate{0};
54
+}
55
+ 
56
+void signal_handler(int signal)
57
+{
58
+    if(signal==SIGTERM)
59
+        terminate = 1;
60
+}
61
+
62
+struct measurement_properties
63
+{
64
+	bool eventswrite{true};
65
+	bool reportswrite{false};
66
+	bool demonize{false};
67
+
68
+	int eventswritten{0};
69
+	int reportswritten{0};
70
+
71
+	std::chrono::seconds maxduration{30};
72
+	unsigned int readreports{0};
73
+
74
+	std::string fileprefix{"radangel"};
75
+	std::string serial{""};
76
+	hid_device *handle;
77
+
78
+	std::chrono::time_point<std::chrono::system_clock> starttime;
79
+	std::chrono::time_point<std::chrono::system_clock> endtime;
80
+
81
+	std::chrono::time_point<std::chrono::steady_clock> startmeastime;
82
+};
83
+
84
+std::string ws2mbs (const wchar_t *ws)
85
+{
86
+	std::mbstate_t state = std::mbstate_t();
87
+	const int len = 1 + std::wcsrtombs (nullptr, &ws, 0, &state);
88
+	std::vector<char> mbs (len);
89
+	std::wcsrtombs (&mbs[0], &ws, mbs.size(), &state);
90
+	return std::string (mbs.data(), mbs.size() );
91
+}
92
+
93
+int writeprotocol (const std::string &filename, measurement_properties &mp)
94
+{
95
+	const int MAX_STR = 255;
96
+
97
+	int res;
98
+
99
+	wchar_t wstr[MAX_STR];
100
+
101
+	libconfig::Config cfg;
102
+
103
+	libconfig::Setting &root = cfg.getRoot();
104
+
105
+	libconfig::Setting &measurement = root.add ("Measurement", libconfig::Setting::TypeGroup);
106
+
107
+	measurement.add ("StartTime", libconfig::Setting::TypeString) = date::format ("%F %T ", date::make_zoned (date::current_zone(), mp.starttime) ) + date::current_zone()->name();
108
+	measurement.add ("EndTime", libconfig::Setting::TypeString) = date::format ("%F %T ", date::make_zoned (date::current_zone(), mp.endtime) ) + date::current_zone()->name();
109
+	measurement.add ("RunAsDaemon", libconfig::Setting::TypeBoolean) = mp.demonize;
110
+	measurement.add ("MaxIntegrationTime_s", libconfig::Setting::TypeInt) = static_cast<int> (mp.maxduration.count() );
111
+	measurement.add ("SavedFilePrefix", libconfig::Setting::TypeString) = mp.fileprefix;
112
+	measurement.add ("CountedReports", libconfig::Setting::TypeInt) = static_cast<int> (mp.readreports);
113
+
114
+	libconfig::Setting &detector = measurement.add ("Detector", libconfig::Setting::TypeGroup);
115
+	libconfig::Setting &usb = detector.add ("USB", libconfig::Setting::TypeGroup);
116
+	// Read the Manufacturer String
117
+	wstr[0] = 0x0000;
118
+	res = hid_get_manufacturer_string (mp.handle, wstr, MAX_STR);
119
+
120
+	if (res == 0)
121
+		usb.add ("Manufacturer", libconfig::Setting::TypeString) = ws2mbs (wstr);
122
+
123
+	// Read the Product String
124
+	wstr[0] = 0x0000;
125
+	res = hid_get_product_string (mp.handle, wstr, MAX_STR);
126
+
127
+	if (res == 0)
128
+		usb.add ("Product", libconfig::Setting::TypeString) = ws2mbs (wstr);
129
+
130
+	// Read the Serial Number String
131
+	wstr[0] = 0x0000;
132
+	res = hid_get_serial_number_string (mp.handle, wstr, MAX_STR);
133
+
134
+	if (res == 0)
135
+		usb.add ("Serial", libconfig::Setting::TypeString) = ws2mbs (wstr);
136
+
137
+	libconfig::Setting &manual = detector.add ("Manual", libconfig::Setting::TypeGroup);
138
+	manual.add ("Serial", libconfig::Setting::TypeString) = mp.serial;
139
+
140
+	libconfig::Setting &clock = measurement.add ("Clock", libconfig::Setting::TypeGroup);
141
+	clock.add ("Steady", libconfig::Setting::TypeBoolean) = std::chrono::steady_clock::is_steady;
142
+	std::chrono::steady_clock::duration unit (1);
143
+	clock.add ("Granularity_ns", libconfig::Setting::TypeInt64) = std::chrono::nanoseconds (unit).count() ;
144
+
145
+	std::array<std::chrono::time_point<std::chrono::steady_clock>, 1000000> vec;
146
+
147
+	for (auto &elem : vec)
148
+		elem = std::chrono::steady_clock::now();
149
+
150
+	std::vector<std::chrono::nanoseconds> differences (vec.size() - 1);
151
+
152
+	for (auto i = 0u; i < differences.size(); i++)
153
+		differences[i] = vec[i + 1] - vec[i];
154
+
155
+	auto result = std::min_element (std::begin (differences), std::end (differences) );
156
+
157
+	clock.add ("MaximumAccuracy_ns", libconfig::Setting::TypeInt64) = result->count();
158
+
159
+	libconfig::Setting &files = measurement.add ("Files", libconfig::Setting::TypeGroup);
160
+
161
+	libconfig::Setting &data = files.add ("Events", libconfig::Setting::TypeList);
162
+	data.add (libconfig::Setting::TypeBoolean) = mp.eventswrite;
163
+	data.add (libconfig::Setting::TypeInt) = mp.eventswritten;
164
+
165
+	libconfig::Setting &report = files.add ("Reports", libconfig::Setting::TypeList);
166
+	report.add (libconfig::Setting::TypeBoolean) = mp.reportswrite;
167
+	report.add (libconfig::Setting::TypeInt) = mp.reportswritten;
168
+
169
+	cfg.writeFile ( (filename + "-protocol.conf").c_str() );
170
+
171
+	return 0;
172
+}
173
+
174
+void read_hid_reports (measurement_properties &mp, zmqpp::context &zmqc)
175
+{
176
+	int ret = 0 ;
177
+	// buffer to transfer data via HID IN-descriptor
178
+	std::array<uint8_t, 63> reportdata{0};// maximum report length specified by RadAngel HID descriptor report 4
179
+
180
+	zmqpp::socket reportsocket (zmqc, mp.reportswrite ? zmqpp::socket_type::publish : zmqpp::socket_type::pair);
181
+	reportsocket.bind ("inproc://rawreports");
182
+	zmqpp::message report;
183
+
184
+	if (mp.demonize)
185
+		sd_notifyf(0, "READY=1\nSTATUS=Processing events…\nMAINPID=%lu", (unsigned long) getpid());
186
+                 
187
+	mp.starttime = std::chrono::system_clock::now();
188
+	mp.startmeastime = std::chrono::steady_clock::now();
189
+
190
+	do
191
+	{
192
+		do
193
+		{
194
+			ret = hid_read (mp.handle, reportdata.data(), reportdata.size() );
195
+
196
+			if (ret == 0)
197
+				std::this_thread::sleep_for (std::chrono::microseconds (500) );
198
+			else if (ret > 0)
199
+				break;
200
+			else
201
+				std::cerr <<  "Unable to read() HID reports!\n";
202
+		}
203
+		while (ret == 0);
204
+
205
+		if (reportdata[0] > 0)
206
+		{
207
+			report << "report"
208
+			       << std::chrono::time_point_cast<std::chrono::microseconds> (std::chrono::steady_clock::now() ).time_since_epoch().count()
209
+			       << ret;
210
+
211
+			for (const auto &element : reportdata)
212
+				report << element;
213
+
214
+			reportsocket.send (report);
215
+
216
+			mp.readreports++;
217
+		}
218
+	}
219
+	while ( (ret >= 0) && (mp.demonize || ( (std::chrono::steady_clock::now() - mp.startmeastime) < mp.maxduration) ) && !terminate );
220
+
221
+	mp.endtime = std::chrono::system_clock::now();
222
+
223
+	report << "done";
224
+	reportsocket.send (report);
225
+	
226
+	if(mp.demonize)
227
+	    sd_notify(0, "STOPPING=1");
228
+}
229
+
230
+void save_hid_reports (measurement_properties &mp, zmqpp::context &zmqc)
231
+{
232
+	mp.reportswritten = 0;
233
+
234
+	if (mp.reportswrite)
235
+	{
236
+		int64_t time = 0;
237
+		int validbytes = 0 ;
238
+
239
+		std::string reporttype;
240
+
241
+		// buffer to transfer data via HID IN-descriptor
242
+		std::array<uint8_t, 63> reportdata{0};// maximum report length specified by RadAngel HID descriptor report 4
243
+
244
+		zmqpp::socket reportsocket (zmqc, zmqpp::socket_type::subscribe);
245
+		reportsocket.connect ("inproc://rawreports");
246
+		reportsocket.subscribe ("");
247
+		zmqpp::message reports;
248
+
249
+		std::ofstream reportsfile;
250
+
251
+		do
252
+		{
253
+			reportsocket.receive (reports);
254
+
255
+			reports >> reporttype;
256
+
257
+			if (reporttype == "report")
258
+			{
259
+				if (!reportsfile.is_open())
260
+				{
261
+					reportsfile.open (mp.fileprefix + date::format ("-%F-%T-%Z", date::make_zoned (date::current_zone(), mp.starttime) ) + "-reports.csv", std::ios::app);
262
+
263
+					reportsfile << "\"relative time since start [µs]\",\"number of valid report bytes\"";
264
+
265
+					for (auto i = 0u; i < 63; i++)
266
+						reportsfile << ",\"report byte " << i << "\"";
267
+
268
+					reportsfile << "\n";
269
+				}
270
+
271
+				reports >> time
272
+				        >> validbytes;
273
+
274
+				for (auto &element : reportdata)
275
+					reports >> element;
276
+
277
+				reportsfile << std::chrono::duration_cast<std::chrono::microseconds> (std::chrono::steady_clock::time_point{std::chrono::microseconds{time}} - mp.startmeastime).count() << ","
278
+				            << validbytes;
279
+
280
+				for (auto &element : reportdata)
281
+					reportsfile << "," << static_cast<int> (element);
282
+
283
+				reportsfile << "\n";
284
+
285
+				mp.reportswritten++;
286
+			}
287
+			else if (reporttype == "done")
288
+				break;
289
+			else
290
+			{
291
+				std::cerr << "reporttype \"" << reporttype << "\" unknown" << std::endl;
292
+				break;
293
+			}
294
+		}
295
+		while (true);
296
+
297
+		if (reportsfile.is_open())
298
+		{
299
+			reportsfile.flush();
300
+			reportsfile.close();
301
+		}
302
+	}
303
+}
304
+
305
+void decode_hid_reports (measurement_properties &mp, zmqpp::context &zmqc)
306
+{
307
+	auto init = true;
308
+	auto reportcounter = 0u;
309
+
310
+	uint8_t validevents = 0;
311
+	uint8_t invalidevents = 0;
312
+	int64_t time;
313
+
314
+	int validbytes;
315
+
316
+	std::string reporttype;
317
+
318
+	// buffer to transfer data via HID IN-descriptor
319
+	std::array<uint8_t, 63> reportdata{0};// maximum report length specified by RadAngel HID descriptor report 4
320
+
321
+	std::array<std::pair<uint16_t, uint8_t>, 31> currentevents;
322
+	std::array<std::array<std::pair<uint16_t, uint8_t>, 31>, 2> oldevents{{{std::make_pair (0, 0) }}};
323
+
324
+	zmqpp::socket reportsocket (zmqc, mp.reportswrite ? zmqpp::socket_type::subscribe : zmqpp::socket_type::pair);
325
+	reportsocket.connect ("inproc://rawreports");
326
+
327
+	if (mp.reportswrite)
328
+		reportsocket.subscribe ("");
329
+
330
+	zmqpp::message reports;
331
+
332
+	zmqpp::socket eventssocket (zmqc, zmqpp::socket_type::publish);
333
+	eventssocket.bind ("inproc://events");
334
+	zmqpp::message events;
335
+
336
+	do
337
+	{
338
+		reportsocket.receive (reports);
339
+
340
+		reports >> reporttype;
341
+
342
+		if (reporttype == "report")
343
+		{
344
+			reports >> time
345
+			        >> validbytes;
346
+
347
+			for (auto &element : reportdata)
348
+				reports >> element;
349
+
350
+			if (reportdata[0] == 4)
351
+			{
352
+				if (validbytes == 63)
353
+				{
354
+					for (auto i = 0u; i < currentevents.size(); i++)
355
+						currentevents[i] = std::make_pair ( ( (reportdata[2 * i + 1] << 8) | reportdata[2 * i + 2]) >> 4, 0x0f & reportdata[2 * i + 2]);
356
+
357
+					validevents = 0;
358
+					invalidevents = 0;
359
+
360
+					for (auto i = 0u; i < currentevents.size(); i++)
361
+						if (currentevents[i] != oldevents[reportcounter % 2][i])
362
+						{
363
+							oldevents[reportcounter % 2][i] = currentevents[i];
364
+
365
+							if (currentevents[i].second != 0)
366
+								validevents++;
367
+							else
368
+								invalidevents++;
369
+						}
370
+						else
371
+						{
372
+							oldevents[reportcounter % 2][i] = currentevents[i];
373
+							currentevents[i].second = 0;
374
+						}
375
+
376
+					if (!init)
377
+					{
378
+						events << "events"
379
+						       << std::chrono::duration_cast<std::chrono::microseconds> (std::chrono::steady_clock::time_point{std::chrono::microseconds{time}} - mp.startmeastime).count()
380
+						       << invalidevents
381
+						       << validevents;
382
+
383
+						for (const auto &element : currentevents)
384
+							if (element.second != 0)
385
+								events << element.first;
386
+
387
+						eventssocket.send (events);
388
+					}
389
+
390
+					reportcounter++;
391
+
392
+					if (init && (reportcounter == 2) )
393
+						init = false;
394
+				}
395
+				else
396
+					std::cerr << "invalid reportsize! received: " << validbytes << " expected: 63\n";
397
+			}
398
+		}
399
+		else if (reporttype == "done")
400
+			break;
401
+		else
402
+		{
403
+			std::cerr << "reporttype \"" << reporttype << "\" unknown" << std::endl;
404
+			break;
405
+		}
406
+	}
407
+	while (true);
408
+
409
+	events << "done";
410
+	eventssocket.send (events);
411
+}
412
+
413
+void save_events (measurement_properties &mp, zmqpp::context &zmqc)
414
+{
415
+	mp.eventswritten = 0;
416
+
417
+	if (mp.eventswrite)
418
+	{
419
+		uint8_t validevents;
420
+		uint8_t invalidevents;
421
+
422
+		int64_t timestamp;
423
+
424
+		std::string eventtype;
425
+
426
+		std::array<uint16_t, 31> currentevents{0};
427
+
428
+		zmqpp::socket eventssocket (zmqc, zmqpp::socket_type::subscribe);
429
+		eventssocket.connect ("inproc://events");
430
+		eventssocket.subscribe ("");
431
+		zmqpp::message events;
432
+
433
+		std::ofstream eventfile;
434
+
435
+		do
436
+		{
437
+			eventssocket.receive (events);
438
+
439
+			events >> eventtype;
440
+
441
+			if (eventtype == "events")
442
+			{
443
+				if (!eventfile.is_open())
444
+				{
445
+					eventfile.open (mp.fileprefix + date::format ("-%F-%T-%Z", date::make_zoned (date::current_zone(), mp.starttime) ) + "-events.csv", std::ios::app);
446
+
447
+					eventfile << "\"relative time since start [µs]\",\"number of invalid events\",\"number of valid events\"";
448
+
449
+					for (auto i = 0u; i < 31; i++)
450
+						eventfile << ",\"event " << i << "\"";
451
+
452
+					eventfile << "\n";
453
+				}
454
+
455
+				events >> timestamp
456
+				       >> invalidevents
457
+				       >> validevents;
458
+
459
+				for (auto i = 0u; i < validevents; i++)
460
+					events >> currentevents[i];
461
+
462
+				eventfile << timestamp << ","
463
+				          << static_cast<int> (invalidevents) << ","
464
+				          << static_cast<int> (validevents);
465
+
466
+				for (auto i = 0u; i < validevents; i++)
467
+					eventfile << "," << static_cast<int> (currentevents[i]);
468
+
469
+				eventfile << "\n";
470
+
471
+				mp.eventswritten++;
472
+			}
473
+			else if (eventtype == "done")
474
+				break;
475
+			else
476
+			{
477
+				std::cerr << "save_events: eventtype \"" << eventtype << "\" unknown" << std::endl;
478
+				break;
479
+			}
480
+		}
481
+		while (true);
482
+
483
+		if (eventfile.is_open() )
484
+		{
485
+			eventfile.flush();
486
+			eventfile.close();
487
+		}
488
+	}
489
+}
490
+
491
+void publish_events (zmqpp::context &zmqc)
492
+{
493
+	uint8_t validevents;
494
+	uint8_t invalidevents;
495
+
496
+	uint16_t currentevent;
497
+
498
+	int64_t timestamp;
499
+
500
+	std::string eventtype;
501
+
502
+	zmqpp::socket eventssocket (zmqc, zmqpp::socket_type::subscribe);
503
+	eventssocket.connect ("inproc://events");
504
+	eventssocket.subscribe ("");
505
+	zmqpp::message events;
506
+
507
+	zmqpp::socket eventpublisher (zmqc, zmqpp::socket_type::publish);
508
+	eventpublisher.bind ("ipc://radangel.events");
509
+	zmqpp::message published_events;
510
+
511
+	do
512
+	{
513
+		eventssocket.receive (events);
514
+
515
+		events >> eventtype;
516
+
517
+		if (eventtype == "events")
518
+		{
519
+			events >> timestamp
520
+			       >> invalidevents
521
+			       >> validevents;
522
+
523
+			for (auto i = 0u; i < validevents; i++)
524
+			{
525
+				events >> currentevent;
526
+
527
+				published_events << currentevent
528
+				                 << timestamp;
529
+
530
+				eventpublisher.send (published_events);
531
+			}
532
+		}
533
+		else if (eventtype == "done")
534
+			break;
535
+		else
536
+		{
537
+			std::cerr << "eventtype \"" << eventtype << "\" unknown" << std::endl;
538
+			break;
539
+		}
540
+	}
541
+	while (true);
542
+}
543
+
544
+void publish_cpm (zmqpp::context &zmqc)
545
+{
546
+	uint8_t validevents;
547
+	uint8_t invalidevents;
548
+
549
+	int64_t timestamp;
550
+	int64_t oldtimestamp = 0;
551
+
552
+	std::string eventtype;
553
+
554
+	zmqpp::socket eventssocket (zmqc, zmqpp::socket_type::subscribe);
555
+	eventssocket.connect ("inproc://events");
556
+	eventssocket.subscribe ("");
557
+	zmqpp::message events;
558
+
559
+	zmqpp::socket cpmsocket (zmqc, zmqpp::socket_type::publish);
560
+	cpmsocket.bind ("ipc://radangel.cpm");
561
+	zmqpp::message cpm;
562
+
563
+	do
564
+	{
565
+		eventssocket.receive (events);
566
+
567
+		events >> eventtype;
568
+
569
+		if (eventtype == "events")
570
+		{
571
+			events  >> timestamp
572
+			        >> invalidevents
573
+			        >> validevents;
574
+
575
+			if (validevents > 0)
576
+			{
577
+				cpm << timestamp
578
+				    << static_cast<double> (validevents / (timestamp - oldtimestamp) * 1000 * 60);
579
+
580
+				cpmsocket.send (cpm);
581
+
582
+				oldtimestamp = timestamp;
583
+			}
584
+		}
585
+		else if (eventtype == "done")
586
+			break;
587
+		else
588
+		{
589
+			std::cerr << "eventtype \"" << eventtype << "\" unknown" << std::endl;
590
+			break;
591
+		}
592
+	}
593
+	while (true);
594
+}
595
+
596
+int main (int argc, char *argv[])
597
+{
598
+	zmqpp::context zmqc;
599
+
600
+	measurement_properties mp;
601
+
602
+	unsigned int integration_time;
603
+
604
+	po::options_description desc ("Available options:");
605
+	desc.add_options()
606
+	("help,?", "Prints this list of available options.")
607
+	("events,e", po::value<bool> (&mp.eventswrite)->implicit_value (true)->default_value (true), "Save events data to disk. File postfix is -data.csv.")
608
+	("reports,r", po::value<bool> (&mp.reportswrite)->implicit_value (true)->default_value (false), "Save received raw usb hid reports to disk. File postfix is -reports.csv.")
609
+	("integrate,i", po::value<unsigned int> (&integration_time)->default_value (30), "Maximum duration of a measurement in seconds.")
610
+	("daemon,d", po::value<bool> (&mp.demonize)->implicit_value (true)->default_value (false), "Run endless as daemon.")
611
+	("prefix,p", po::value<std::string> (&mp.fileprefix)->default_value ("radangel"), "Prefix for the files generated.")
612
+	("serial,s", po::value<std::string> (&mp.serial), "Serial number of detector.")
613
+	;
614
+
615
+	po::positional_options_description p;
616
+	p.add ("prefix", -1);
617
+
618
+	po::variables_map vm;
619
+	po::store (po::command_line_parser (argc, argv).options (desc).positional (p).run(), vm);
620
+	po::notify (vm);
621
+
622
+	if (vm.count ("help") )
623
+	{
624
+		std::cout << "Usage: " << argv[0] << " [options] [prefix]\n";
625
+		std::cout << desc;
626
+		return 0;
627
+	}
628
+
629
+	mp.maxduration = std::chrono::seconds{integration_time};
630
+
631
+	if (vm.count ("daemon") && !vm["daemon"].defaulted() && vm["integrate"].defaulted() )
632
+		mp.maxduration = std::numeric_limits<std::chrono::seconds>::max();
633
+
634
+	if (hid_init() )
635
+		return 1;
636
+
637
+	mp.handle = hid_open (0x4d8, 0x100, NULL);
638
+
639
+	if (!mp.handle)
640
+	{
641
+		std::cerr << "unable to open device\n";
642
+		return 4;
643
+	}
644
+
645
+	// Set the hid_read() function to be non-blocking.
646
+	hid_set_nonblocking (mp.handle, 1);
647
+
648
+	std::signal (SIGTERM, signal_handler);
649
+
650
+	if(!terminate)
651
+	{
652
+		std::thread publishCPM (publish_cpm, std::ref (zmqc) );
653
+		std::thread publishEvents (publish_events, std::ref (zmqc) );
654
+		std::thread saveEvents (save_events, std::ref (mp), std::ref (zmqc) );
655
+		std::thread decodeReports (decode_hid_reports, std::ref (mp), std::ref (zmqc) );
656
+		std::thread saveHIDReports (save_hid_reports, std::ref (mp), std::ref (zmqc) );
657
+		std::thread readHIDReports (read_hid_reports, std::ref (mp), std::ref (zmqc) );
658
+
659
+		publishCPM.join();
660
+		publishEvents.join();
661
+		saveEvents.join();
662
+		decodeReports.join();
663
+		saveHIDReports.join();
664
+		readHIDReports.join();
665
+
666
+		// write measurement protocol
667
+		writeprotocol (mp.fileprefix + date::format ("-%F-%T-%Z", date::make_zoned (date::current_zone(), mp.starttime) ), mp);
668
+	}
669
+
670
+	hid_close (mp.handle);
671
+
672
+	// Free static HIDAPI objects.
673
+	hid_exit();
674
+
675
+	return 0;
676
+}

+ 10
- 0
radangeld/meson.build Vedi File

@@ -0,0 +1,10 @@
1
+subdir('resources')
2
+
3
+tz_dep = dependency('tz', fallback : ['hinnant-date', 'tz_dep'], default_options : ['use_system_tzdb=true'])
4
+hidapi_usb_dep = dependency('hidapi-libusb')
5
+boost_dep = dependency('boost', modules : 'program_options')
6
+libconfigpp_dep = dependency('libconfig++')
7
+zmqpp_dep = dependency('libzmqpp')
8
+libsystemd_dep = dependency('libsystemd')
9
+
10
+executable('radangeld', 'main.cpp', dependencies : [hidapi_usb_dep, boost_dep, libconfigpp_dep, libsystemd_dep, thread_dep, zmqpp_dep, tz_dep])

+ 3
- 0
radangeld/resources/69-kromek-radangel.rules Vedi File

@@ -0,0 +1,3 @@
1
+# Kromek Radangel & RA4S rules
2
+SUBSYSTEM=="usb", ACTION=="add", ATTR{ID_VENDOR_ID}=="04d8", ATTR{ID_MODEL_ID}=="0100", ATTR{ID_VENDOR}=="Kromek", ATTR{ID_MODEL}=="LCS", GROUP="input", TAG+="uaccess"
3
+

+ 15
- 0
radangeld/resources/meson.build Vedi File

@@ -0,0 +1,15 @@
1
+if install_udev_dir
2
+  data = files( '69-kromek-radangel.rules' )
3
+
4
+  install_data(data, install_dir: join_paths(udev_dir, 'rules.d'))
5
+endif
6
+
7
+bindir_conf = configuration_data()
8
+bindir_conf.set('bindir', join_paths (get_option ('prefix'), get_option ('bindir')))
9
+
10
+if install_systemd_unit_dir
11
+configure_file(input: 'radangeld.service.in',
12
+               output: 'radangeld.service',
13
+               configuration: bindir_conf,
14
+               install_dir: systemd_unit_dir)
15
+endif

+ 9
- 0
radangeld/resources/radangeld.service.in Vedi File

@@ -0,0 +1,9 @@
1
+[Unit]
2
+Description=Daemon that reads, decodes and distributes events from a Kromek Radangel γ-spectrometer 
3
+
4
+[Service]
5
+Type=notify
6
+ExecStart=@bindir@/radangeld -e 0 -d
7
+
8
+[Install]
9
+WantedBy=multi-user.target

+ 9
- 0
subprojects/hinnant-date.wrap Vedi File

@@ -0,0 +1,9 @@
1
+[wrap-file]
2
+source_url=https://github.com/HowardHinnant/date/archive/v2.4.1.tar.gz
3
+source_filename=date-2.4.1.tar.gz
4
+source_hash=98907d243397483bd7ad889bf6c66746db0d7d2a39cc9aacc041834c40b65b98
5
+directory=date-2.4.1
6
+
7
+patch_url = https://wrapdb.mesonbuild.com/v1/projects/hinnant-date/2.4.1/1/get_zip
8
+patch_filename = hinnant-date-2.4.1-1-wrap.zip
9
+patch_hash = 2061673a6f8e6d63c3a40df4da58fa2b3de2835fd9b3e74649e8279599f3a8f6

Loading…
Annulla
Salva