├── LICENSE
├── README.md
├── backtotop.svg
└── commandha.go
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Wire-Pod Vector Command HomeAssistant
2 | Wire-Pod GO plugin for Anki Vector Robot to talk to and send commands to Home Assistant via the Conversation API
3 |
4 | 
5 |
6 | ##### Table of Contents
7 | - [YouTube Short](#youtube-short)
8 | - Home Assistant
9 | - [Home Assistant Container for Docker](#home-assistant-container-for-docker)
10 | - [Home-LLM on a GPU server](#home-llm-on-a-gpu-server)
11 | - [Wyoming-Whisper Container for Docker](#wyoming-whisper-container-for-docker)
12 | - [Manual Docker Config](#manual-docker-config)
13 | - [Wyoming-Piper Docker Container](#wyoming-piper-docker-container)
14 | - [Manual Docker Config](#manual-docker-config-1)
15 | - [Wyoming-OpenWakeWord Container for Docker](#wyoming-openwakeword-container-for-docker)
16 | - [Manual Docker Config](#manual-docker-config-2)
17 | - [Wyoming Protocol](#wyoming-protocol)
18 | - [Home Assistant Groups](#home-assistant-groups)
19 | - Wire-Pod
20 | - [Wire-Pod LXC](#wire-pod-lxc)
21 | - [Wire-Pod Docker](#wire-pod-docker)
22 | - [Compile](#compile)
23 | - [AgentID](#agentid)
24 | - [Compiling](#compiling)
25 | - [Testing, testing, 123](#testing-testing-123)
26 | - Other Things
27 | - [Extra](#extra) HA Vector Voice Announce
28 | - [Useful links](#useful-links)
29 |
30 | ## YouTube Short ##
31 |
32 | [](https://www.youtube.com/watch?v=i7WPcnAWji8)
33 |
34 | ^ https://youtube.com/shorts/i7WPcnAWji8 ^
35 |
36 | ## Home Assistant Container for Docker ##
37 |
38 | ```yaml
39 | #HomeAssistant Container for Docker
40 | version: "3.9"
41 | services:
42 | homeassistant:
43 | container_name: homeassistant
44 | image: "ghcr.io/home-assistant/home-assistant:stable"
45 | volumes:
46 | - /var/lib/libvirt/images/usb001/docker-storage/homeassistant/config:/config
47 | - /etc/localtime:/etc/localtime:ro
48 | mac_address: de:ad:be:ef:00:08
49 | networks:
50 | - dhcp
51 | devices:
52 | - /dev/ttyACM0:/dev/ttyACM0
53 | restart: "no"
54 | privileged: true
55 |
56 | networks:
57 | dhcp:
58 | name: dbrv100
59 | external: true
60 | ```
61 |
62 | ## Home-LLM on a GPU server ##
63 | [](https://my.home-assistant.io/redirect/hacs_repository/?category=Integration&repository=home-llm&owner=acon96)
64 |
65 | Clone or download the repository https://github.com/oobabooga/text-generation-webui install it however you please I just run it on the metal of a GPU server.
66 |
67 | **Note:** _You currently need an unreleased tag of text-generation-webui to work with the V2 model of Home-LLM which you can get like this until fully released_
68 |
69 | ```bash
70 | git clone https://github.com/oobabooga/text-generation-webui.git
71 | cd text-generation-webui
72 | git checkout -b llamacpp_0.2.29 origin/llamacpp_0.2.29
73 | git branch
74 | git pull
75 | echo "--listen --api --model Home-3B-v2.q8_0.gguf --n-gpu-layers 33" >> CMD_FLAGS.txt
76 | ./start_linux.sh
77 | ```
78 |
79 | Edit CMD_FLAGS.txt before installing uncomment the line `# --listen --api` (Remove the number sign and space) I also added `--model Home-3B-v2.q8_0.gguf --n-gpu-layers 33` for my GPU to start the model on boot.
80 |
81 | Run the start_linux.sh, start_windows.bat, start_macos.sh, or start_wsl.bat script depending on your OS.
82 |
83 | Select your GPU vendor when asked.
84 |
85 | Once the installation ends, browse to http://GPUServerIP:7860/?__theme=dark.
86 |
87 | Download the gguf file from acon96/Home-3B-v2-GGUF and Home-3B-v2.q8_0.gguf for max GPU potential in the text-generation-webui.
88 |
89 | Select the reload button when it is done downloading (2.8G) the file Home-3B-v2.q8_0.gguf should show up in the Model list then hit Load and Save settings.
90 |
91 | 
92 |
93 | Excerpt from Home-LLM
94 | ```
95 | Performance of running the model on a Raspberry Pi
96 |
97 | The RPI4 4GB that I have was sitting right at 1.5 tokens/sec for prompt eval and 1.6 tokens/sec for token generation when running the Q4_K_M quant. I was reliably getting responses in 30-60 seconds after the initial prompt processing which took almost 5 minutes. It depends significantly on the number of devices that have been exposed as well as how many states have changed since the last invocation because of llama.cpp caches KV values for identical prompt prefixes.
98 |
99 | It is highly recommended to set up text-generation-webui on a separate machine that can take advantage of a GPU.
100 | ```
101 |
102 | Start-up on boot of the GPU server.
103 | ```
104 | #/etc/systemd/system/textgen.service
105 | [Unit]
106 | After=network.target
107 |
108 | [Service]
109 | Type=simple
110 | ExecStart=/bin/bash /opt/code/text-generation-webui/start_linux.sh
111 | User=textgen
112 | Group=textgen
113 |
114 | [Install]
115 | WantedBy=multi-user.target
116 | ```
117 |
118 | Add user textgen and to groups video/render
119 |
120 | ```bash
121 | sudo useradd -m -s /bin/bash -G render,video textgen
122 | sudo passwd textgen
123 | id textgen
124 | uid=1001(textgen) gid=1001(textgen) groups=1001(textgen),44(video),109(render)
125 | sudo chown -R textgen:textgen /opt/text-generation-webui/
126 | ```
127 |
128 | Test your user to make sure it can run text-generation-webui
129 |
130 | ```bash
131 | su textgen
132 | cd /opt/text-generation-webui
133 | ./start_linux.sh
134 | 08:11:51-750558 INFO Starting Text generation web UI
135 | 08:11:51-753175 WARNING
136 | You are potentially exposing the web UI to the entire internet without any access password.
137 | You can create one with the "--gradio-auth" flag like this:
138 |
139 | --gradio-auth username:password
140 |
141 | Make sure to replace username:password with your own.
142 | 08:11:51-822630 INFO Loading Home-3B-v2.q8_0.gguf
143 | 08:11:51-907601 INFO llama.cpp weights detected: models/Home-3B-v2.q8_0.gguf
144 | ggml_init_cublas: GGML_CUDA_FORCE_MMQ: no
145 | ggml_init_cublas: CUDA_USE_TENSOR_CORES: yes
146 | ggml_init_cublas: found 1 ROCm devices:
147 | Device 0: Radeon RX Vega, compute capability 9.0, VMM: no
148 | llama_model_loader: loaded meta data with 19 key-value pairs and 453 tensors from models/Home-3B-v2.q8_0.gguf (version GGUF V3 (latest))
149 | llama_model_loader: Dumping metadata keys/values. Note: KV overrides do not apply in this output.
150 | llama_model_loader: - kv 0: general.architecture str = phi2
151 | llama_model_loader: - kv 1: general.name str = Phi2
152 | llama_model_loader: - kv 2: phi2.context_length u32 = 2048
153 | llama_model_loader: - kv 3: phi2.embedding_length u32 = 2560
154 | llama_model_loader: - kv 4: phi2.feed_forward_length u32 = 10240
155 | llama_model_loader: - kv 5: phi2.block_count u32 = 32
156 | llama_model_loader: - kv 6: phi2.attention.head_count u32 = 32
157 | llama_model_loader: - kv 7: phi2.attention.head_count_kv u32 = 32
158 | llama_model_loader: - kv 8: phi2.attention.layer_norm_epsilon f32 = 0.000010
159 | llama_model_loader: - kv 9: phi2.rope.dimension_count u32 = 32
160 | llama_model_loader: - kv 10: general.file_type u32 = 7
161 | llama_model_loader: - kv 11: tokenizer.ggml.add_bos_token bool = false
162 | llama_model_loader: - kv 12: tokenizer.ggml.model str = gpt2
163 | llama_model_loader: - kv 13: tokenizer.ggml.tokens arr[str,51200] = ["!", "\"", "#", "$", "%", "&", "'", ...
164 | llama_model_loader: - kv 14: tokenizer.ggml.token_type arr[i32,51200] = [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, ...
165 | llama_model_loader: - kv 15: tokenizer.ggml.merges arr[str,50000] = ["Ġ t", "Ġ a", "h e", "i n", "r e",...
166 | llama_model_loader: - kv 16: tokenizer.ggml.bos_token_id u32 = 50296
167 | llama_model_loader: - kv 17: tokenizer.ggml.eos_token_id u32 = 50297
168 | llama_model_loader: - kv 18: general.quantization_version u32 = 2
169 | llama_model_loader: - type f32: 259 tensors
170 | llama_model_loader: - type q8_0: 194 tensors
171 | llm_load_vocab: mismatch in special tokens definition ( 910/51200 vs 944/51200 ).
172 | llm_load_print_meta: format = GGUF V3 (latest)
173 | llm_load_print_meta: arch = phi2
174 | llm_load_print_meta: vocab type = BPE
175 | llm_load_print_meta: n_vocab = 51200
176 | llm_load_print_meta: n_merges = 50000
177 | llm_load_print_meta: n_ctx_train = 2048
178 | llm_load_print_meta: n_embd = 2560
179 | llm_load_print_meta: n_head = 32
180 | llm_load_print_meta: n_head_kv = 32
181 | llm_load_print_meta: n_layer = 32
182 | llm_load_print_meta: n_rot = 32
183 | llm_load_print_meta: n_embd_head_k = 80
184 | llm_load_print_meta: n_embd_head_v = 80
185 | llm_load_print_meta: n_gqa = 1
186 | llm_load_print_meta: n_embd_k_gqa = 2560
187 | llm_load_print_meta: n_embd_v_gqa = 2560
188 | llm_load_print_meta: f_norm_eps = 1.0e-05
189 | llm_load_print_meta: f_norm_rms_eps = 0.0e+00
190 | llm_load_print_meta: f_clamp_kqv = 0.0e+00
191 | llm_load_print_meta: f_max_alibi_bias = 0.0e+00
192 | llm_load_print_meta: n_ff = 10240
193 | llm_load_print_meta: n_expert = 0
194 | llm_load_print_meta: n_expert_used = 0
195 | llm_load_print_meta: rope scaling = linear
196 | llm_load_print_meta: freq_base_train = 10000.0
197 | llm_load_print_meta: freq_scale_train = 1
198 | llm_load_print_meta: n_yarn_orig_ctx = 2048
199 | llm_load_print_meta: rope_finetuned = unknown
200 | llm_load_print_meta: model type = 3B
201 | llm_load_print_meta: model ftype = Q8_0
202 | llm_load_print_meta: model params = 2.78 B
203 | llm_load_print_meta: model size = 2.75 GiB (8.51 BPW)
204 | llm_load_print_meta: general.name = Phi2
205 | llm_load_print_meta: BOS token = 50296 '<|im_start|>'
206 | llm_load_print_meta: EOS token = 50297 '<|im_end|>'
207 | llm_load_print_meta: LF token = 128 'Ä'
208 | llm_load_tensors: ggml ctx size = 0.35 MiB
209 | llm_load_tensors: offloading 32 repeating layers to GPU
210 | llm_load_tensors: offloading non-repeating layers to GPU
211 | llm_load_tensors: offloaded 33/33 layers to GPU
212 | llm_load_tensors: ROCm0 buffer size = 2686.46 MiB
213 | llm_load_tensors: CPU buffer size = 132.81 MiB
214 | ............................................................................................
215 | llama_new_context_with_model: n_ctx = 2048
216 | llama_new_context_with_model: freq_base = 10000.0
217 | llama_new_context_with_model: freq_scale = 1
218 | llama_kv_cache_init: ROCm0 KV buffer size = 640.00 MiB
219 | llama_new_context_with_model: KV self size = 640.00 MiB, K (f16): 320.00 MiB, V (f16): 320.00 MiB
220 | llama_new_context_with_model: graph splits (measure): 3
221 | llama_new_context_with_model: ROCm0 compute buffer size = 147.00 MiB
222 | llama_new_context_with_model: ROCm_Host compute buffer size = 9.00 MiB
223 | AVX = 1 | AVX_VNNI = 0 | AVX2 = 1 | AVX512 = 0 | AVX512_VBMI = 0 | AVX512_VNNI = 0 | FMA = 1 | NEON = 0 | ARM_FMA = 0 | F16C = 1 | FP16_VA = 0 | WASM_SIMD = 0 | BLAS = 1 | SSE3 = 1 | SSSE3 = 1 | VSX = 0 |
224 | 08:11:56-083810 INFO LOADER: llama.cpp
225 | 08:11:56-084582 INFO TRUNCATION LENGTH: 2048
226 | 08:11:56-085278 INFO INSTRUCTION TEMPLATE: Alpaca
227 | 08:11:56-085904 INFO Loaded the model in 4.26 seconds.
228 | 08:11:56-086636 INFO Loading the extension "openai"
229 | 08:11:56-153090 INFO OpenAI-compatible API URL:
230 |
231 | http://0.0.0.0:5000
232 |
233 | 08:11:56-154806 INFO Loading the extension "gallery"
234 | Running on local URL: http://0.0.0.0:7860
235 |
236 | To create a public link, set `share=True` in `launch()`.
237 | ```
238 |
239 | Looks good! If you get permission issues check your permissions on the /opt/text-generation-webui folder
240 |
241 | ```
242 | sudo systemctl daemon-reload
243 | sudo systemctl enable textgen.service
244 | sudo systemctl start textgen.service
245 | sudo systemctl status textgen.service
246 | ● textgen.service
247 | Loaded: loaded (/etc/systemd/system/textgen.service; enabled; vendor preset: enabled)
248 | Active: active (running) since Mon 2024-01-22 07:53:18 UTC; 5s ago
249 | Main PID: 2499 (bash)
250 | Tasks: 8 (limit: 18905)
251 | Memory: 254.5M
252 | CPU: 4.054s
253 | CGroup: /system.slice/textgen.service
254 | ├─2499 /bin/bash /opt/text-generation-webui/start_linux.sh
255 | ├─2512 python one_click.py
256 | ├─2517 /bin/sh -c ". \"/opt/text-generation-webui/installer_files/conda/etc/profile.d/conda.sh\" && conda activate \"/opt/text-generation-webui/installer_files/env\" && python server.py --listen --api --model Home-3B-v2.q8_0.gguf --n-gpu-layers 33"
257 | └─2520 python server.py --listen --api --model Home-3B-v2.q8_0.gguf --n-gpu-layers 33
258 |
259 | systemd[1]: Started textgen.service.
260 | ```
261 |
262 | Add the GPU server IP and port (5000) to your Home-LLM integration.
263 |
264 | Select text-generation-webui API in the dropdown then hit SUBMIT.
265 |
266 | 
267 |
268 | The GPU Server IP that is running text-generation-webui
269 |
270 | API Hostname*: 10.0.0.42
271 |
272 | The backend port for text-generation-webui 5000 is the default for text-generation-webui (not 7860 which is the webui)
273 |
274 | API Port*: 5000
275 |
276 | Model name has to be the exact same as it looks in the dropdown model list in text-generation-webui
277 |
278 | Model Name*: Home-3B-v2_q8_0.gguf
279 |
280 | Chat completions endpoint is how the URLs get formed to post data to text-generation-webui without this checked it will use /v1/completions which is depreciated for /v1/chat/completions (Both currently still work but let's think about the future).
281 |
282 | [X] Use chat completions endpoint
283 |
284 | API Key doesn't matter can type anything or nothing at all.
285 |
286 | API key: na
287 |
288 | 
289 |
290 | Select SUBMIT and hope for Success!
291 |
292 | 
293 |
294 | 
295 |
296 |
297 |
298 | ## Wyoming-Whisper Container for Docker ##
299 |
300 | [](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_whisper)
301 |
302 | #### Manual Docker Config ####
303 | ```yaml
304 | # docker run -it -p 10300:10300 -v /path/to/local/data:/data rhasspy/wyoming-whisper --model tiny-int8 --language en
305 | # Whisper Container for Docker
306 | version: "3.9"
307 | services:
308 | wyoming-whisper:
309 | image: rhasspy/wyoming-whisper:latest
310 | labels:
311 | - "com.centurylinklabs.watchtower.enable=true"
312 | - "com.centurylinklabs.watchtower.monitor-only=false"
313 | container_name: whisper
314 | volumes:
315 | - /etc/localtime:/etc/localtime:ro
316 | - /var/lib/libvirt/images/usb001/docker-storage/wyoming-whisper/data:/data
317 | #- /etc/asound.conf:/etc/asound.conf
318 | mac_address: "de:ad:be:ef:5e:34"
319 | networks:
320 | - dhcp
321 | devices:
322 | - /dev/snd:/dev/snd
323 | ports:
324 | - 10300:10300 # http
325 | command: --model tiny-int8 --language en
326 | restart: "no"
327 | networks:
328 | dhcp:
329 | name: "dbrv100"
330 | ```
331 |
332 | ## Wyoming-Piper Docker Container ##
333 |
334 | [](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_piper)
335 |
336 | #### Manual Docker Config ####
337 | ```yaml
338 | # docker run -it -p 10200:10200 -v /path/to/local/data:/data rhasspy/wyoming-piper --voice en-us-lessac-low
339 | # Piper Container for Docker
340 | version: "3.9"
341 | services:
342 | wyoming-piper:
343 | image: rhasspy/wyoming-piper:latest
344 | labels:
345 | - "com.centurylinklabs.watchtower.enable=true"
346 | - "com.centurylinklabs.watchtower.monitor-only=false"
347 | container_name: piper
348 | volumes:
349 | - /etc/localtime:/etc/localtime:ro
350 | - /var/lib/libvirt/images/usb001/docker-storage/wyoming-piper/data:/data
351 | mac_address: "de:ad:be:ef:5e:35"
352 | networks:
353 | - dhcp
354 | ports:
355 | - 10200:10200 # http
356 | command: --voice en-us-lessac-low
357 | restart: "no"
358 | networks:
359 | dhcp:
360 | name: "dbrv100"
361 | ```
362 |
363 | ## Wyoming-OpenWakeWord Container for Docker ##
364 |
365 | [](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_openwakeword)
366 |
367 | #### Manual Docker Config ####
368 | ```yaml
369 | # Wyoming-OpenWakeWord Container for Docker
370 | version: "3.9"
371 | services:
372 | wyomingopenwakeword:
373 | container_name: "wyoming-openwakeword"
374 | image: "rhasspy/wyoming-openwakeword:latest"
375 | labels:
376 | - "com.centurylinklabs.watchtower.enable=true"
377 | - "com.centurylinklabs.watchtower.monitor-only=false"
378 | volumes:
379 | - /etc/localtime:/etc/localtime:ro
380 | - /var/lib/libvirt/images/usb001/docker-storage/wyoming-openwakeword/data:/data
381 | mac_address: "de:ad:be:ef:5e:36"
382 | hostname: "wyomingopenwakeword"
383 | networks:
384 | - dhcp
385 | ports:
386 | - 10400:10400
387 | devices:
388 | - /dev/snd:/dev/snd
389 | command: --model 'ok_nabu' --model 'hey_jarvis' --model 'hey_rhasspy' --model 'hey_mycroft' --model 'alexa' --preload-model 'ok_nabu'
390 | # --uri 'tcp://0.0.0.0:10400'
391 | restart: "no"
392 | #restart: unless-stopped
393 | #privileged: true
394 | #network_mode: host
395 |
396 | networks:
397 | dhcp:
398 | name: "dbrv100"
399 | external: true
400 | ```
401 |
402 | ## Wyoming Protocol ##
403 |
404 | [](https://my.home-assistant.io/redirect/config_flow_start?domain=wyoming)
405 |
406 | 
407 |
408 | In the Wyoming protocol integration click "Add Entry" and enter the IP and Port of the three Whisper/Piper/OpenWakeWord dockers so 10200, 10300, 10400, and their corresponding IP.
409 |
410 | Then go under the settings -> voice assistant -> add assistant.
411 |
412 | Name your assistant.
413 |
414 | Select your conversation agent like Home Assistant or your Home LLM, etc.
415 |
416 | Home LLM has some options as well that you can play with
417 |
418 | 
419 |
420 | Then drop down the boxes for Faster-Whisper, Piper, and OpenWakeWord. Select the settings you like for each.
421 |
422 | 
423 |
424 | Then give it a test
425 |
426 | 
427 |
428 | 
429 |
430 | ## Home Assistant Groups ##
431 |
432 | Currently, the model doesn't support turning off areas so you require this integration to get that working with the model
433 |
434 | https://www.home-assistant.io/integrations/group/
435 |
436 | [](https://my.home-assistant.io/redirect/config_flow_start?domain=group)
437 |
438 | 
439 |
440 | 
441 |
442 | ## Wire-Pod LXC ##
443 |
444 | I recently switched to using LXC as I was modifying the docker too much. Yes persistent storage would be a lot better for not losing code/settings if you update the docker container. The Docker config is still below but I prefer this option.
445 |
446 | /etc/netplan/xx-someautogen.yaml
447 | ```yaml
448 | network:
449 | version: 2
450 | renderer: networkd
451 | ethernets:
452 | enp3s0:
453 | dhcp4: no
454 | bridges:
455 | br0:
456 | dhcp4: yes
457 | interfaces:
458 | - enp3s0
459 | ```
460 |
461 | ```bash
462 | sudo apt install lxc
463 | sudo lxc init
464 | Would you like to use LXD clustering? (yes/no) [default=no]: no
465 | Do you want to configure a new storage pool? (yes/no) [default=yes]: yes
466 | Name of the new storage pool [default=default]: default
467 | Name of the storage backend to use (btrfs, ceph, dir, lvm, zfs) [default=zfs]:
468 | dir
469 | Would you like to connect to a MAAS server? (yes/no) [default=no]: no
470 | Would you like to create a new local network bridge? (yes/no) [default=yes]: yes
471 | What should the new bridge be called? [default=lxdbr0]: lxdbr0
472 | What IPv4 address should be used? (CIDR subnet notation, “auto” or “none”) [default=auto]: auto
473 | What IPv6 address should be used? (CIDR subnet notation, “auto” or “none”) [default=auto]: auto
474 | Would you like LXC to be available over the network? (yes/no) [default=no]: yes
475 | Would you like stale cached images to be updated automatically? (yes/no) [default=yes]: yes
476 | Would you like a YAML "lxd init" preseed to be printed? (yes/no) [default=no]: yes
477 | ```
478 |
479 | ```bash
480 | sudo lxc-create -t download -n wirepod -- --dist ubuntu --release jammy --arch amd64
481 | ```
482 |
483 | ```bash
484 | sudo lxc-ls
485 | wirepod
486 | sudo lxc-stop -n wirepod
487 | ```
488 |
489 | ```bash
490 | sudo vim /var/lib/lxc/wirepod/config
491 | # Distribution configuration
492 | lxc.include = /usr/share/lxc/config/common.conf
493 | lxc.arch = linux64
494 |
495 | # Container specific configuration
496 | lxc.rootfs.path = dir:/var/lib/lxc/wirepod/rootfs
497 | lxc.uts.name = wirepod
498 | lxc.start.auto = 1
499 |
500 | # Network configuration
501 | lxc.net.0.type = veth
502 | lxc.net.0.link = br0
503 | lxc.net.0.flags = up
504 | lxc.net.0.hwaddr = de:ad:be:ef:ca:fe
505 | ```
506 |
507 | ```bash
508 | sudo lxc-start -n wirepod
509 | sudo lxc-attach -n wirepod
510 | git clone https://github.com/kercre123/wire-pod --depth=1
511 | cd wire-pod
512 | sudo STT=vosk ./setup.sh
513 | ./setup.sh daemon-enable
514 | systemctl start wire-pod
515 | systemctl status wire-pod
516 | ```
517 |
518 | ## Wire-Pod Docker ##
519 |
520 | For docker you will need to look at how to add a docker container to a bridge so that it grabs the IP from your router and not the docker subnet. ( I was using the docker-net-dhcp plugin. On newer versions of docker you may have to look for an issue on their tracker about freezing on boot which I was in and list how to compile it to get it working properly. https://github.com/devplayer0/docker-net-dhcp/issues/23#issuecomment-1967410354 ) but there are other things like [macvlan](https://docs.docker.com/network/drivers/macvlan/) [ipvlan](https://docs.docker.com/network/drivers/ipvlan/) etc. (I was having issues with them where they can't communicate to the host properly that is why I was using the plugin)
521 |
522 | I use to use docker to run Vector with Wire-Pod my old configuration looks like this:
523 |
524 | ```docker
525 | FROM ubuntu:latest
526 |
527 | # Edit your timezone here:
528 | ENV TZ=Europe/London
529 | RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
530 | RUN apt-get update \
531 | && apt-get install -y sudo
532 |
533 | RUN adduser --disabled-password --gecos '' wirepod
534 | RUN adduser wirepod sudo
535 | RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
536 |
537 | USER wirepod
538 |
539 | RUN sudo apt-get update && sudo apt-get install -y git
540 | RUN sudo mkdir /wire-pod
541 | RUN sudo chown -R wirepod:wirepod /wire-pod
542 |
543 | RUN cd /wire-pod
544 | RUN git clone https://github.com/kercre123/wire-pod/ wire-pod
545 |
546 | WORKDIR /wire-pod
547 |
548 | RUN sudo STT=vosk /wire-pod/setup.sh
549 |
550 | WORKDIR /wire-pod/chipper
551 |
552 | CMD sudo /wire-pod/chipper/start.sh
553 | ```
554 |
555 | ```bash
556 | sudo docker build -t wire-pod .
557 | ```
558 |
559 | My Docker Compose looks like this
560 | ```yaml
561 | # Wire-Pod Container for Docker
562 | # https://github.com/kercre123/wire-pod/wiki/Installation
563 | version: "3.9"
564 | services:
565 | wirepod:
566 | container_name: "wirepod"
567 | image: "wire-pod:latest"
568 | #labels:
569 | # - "com.centurylinklabs.watchtower.enable=true"
570 | # - "com.centurylinklabs.watchtower.monitor-only=false"
571 | volumes:
572 | - /var/lib/libvirt/images/usb001/docker-storage/wirepod/data:/data
573 | # - /run/dbus:/run/dbus:ro # This should technically get dbus running for Avahi but didn't seem to work for me.
574 | # May have to use dbus-broker instead of dbus-daemon.
575 | mac_address: "9e:de:ad:be:ef:42"
576 | hostname: escapepod
577 | #networks:
578 | # - dhcp
579 | ports:
580 | - 80:80
581 | - 8080:8080
582 | - 443:443
583 | - 8084:8084
584 | - 5353:5353/udp
585 | restart: "no" # Turn this to unless-stopped if you think everything is ok
586 | # If you use docker-net-dhcp like me keep this set to no so your dockerd doesn't hang on boot.
587 | #networks:
588 | # dhcp:
589 | # name: "dbrv42"
590 | # external: true
591 | ```
592 | ```bash
593 | docker compose up -d
594 | ```
595 |
596 | ## Compile ##
597 |
598 | After that attach to the docker
599 |
600 | ```bash
601 | docker exec -it wirepod /bin/bash
602 | ```
603 | You should be met with the cli prompt
604 | ```bash
605 | wirepod@escapepod:/wire-pod/chipper$
606 | cd plugins
607 | mkdir commandha
608 | cd commandha
609 | wget https://raw.githubusercontent.com/NonaSuomy/WirePodVectorCommandHomeAssistant/main/commandha.go
610 | ```
611 | Edit the commandha.go file to add your long-lived access token and the IP of your HA instance
612 |
613 | ```
614 | url := "http://HAIPHERE:8123/api/conversation/process" // Replace with your Home Assistant IP
615 | token := "LONGTOKENHERE" // Replace with your token
616 | //agentID := "AgentIDHere" // Replace with your agent_id (Can get this with the dev assist console in YAML view or try the name)
617 | ```
618 |
619 | ### AgentID ###
620 |
621 | **Note:** _Uncommenting AgentID stuff in the code is not required to use the default HA agent! It is an optional setting when you have multiple agents that are not the default agent in Home Assistant. Uncommenting these in the go code and not setting the AgentID properly may give you HTML status codes that you can't see and may not work. Test the default agent before using this._
622 |
623 | If you want Vector to use a specific Agent ID you setup for him under assist manager. You need to uncomment these three lines and add your agentID := "################################" etc, to the middle one. Otherwise, it will use the default one.
624 |
625 | 
626 |
627 | Grab the agent_id:
628 |
629 | 
630 |
631 | ```C
632 | //AgentID string `json:"agent_id"`
633 |
634 | //agentID := "AgentIDHere" // Replace with your agent_id (Can get this with the dev assist console in YAML view or try the name)
635 |
636 | //AgentID: agentID,
637 | ```
638 |
639 | **Note:** _If you delete and remake your agent in the HA setup it will generate a new AgentID which you will then have to recompile into this and restart the server/vector._
640 |
641 | ### Compiling ###
642 | Compile the GO plugin to the root directory of /wire-pod/chipper/plugins
643 | ```bash
644 | sudo /usr/local/go/bin/go build -buildmode=plugin -o /wire-pod/chipper/plugins/commandha.so commandha.go
645 | ```
646 |
647 | Restart your wirepod docker
648 |
649 | ```bash
650 | docker container restart wirepod
651 | ```
652 |
653 | ## Testing, testing, 123 ##
654 |
655 | In the console log you should see
656 |
657 | ```
658 | docker logs wirepod
659 | ```
660 |
661 | ```
662 | SDK info path: /tmp/.anki_vector/
663 | API config successfully read
664 | Loaded jdocs file
665 | Loaded bot info file, known bots: [00######]
666 | Reading session certs for robot IDs
667 | Loaded 54 intents and 54 matches (language: en-US)
668 | Initiating vosk voice processor with language en-US
669 | Opening VOSK model (../vosk/models/en-US/model)
670 | Initializing VOSK recognizers
671 | VOSK initiated successfully
672 | ```
673 | After this it should load our compiled plugin
674 | ```
675 | Loading plugins
676 | Loading plugin: comandha.so
677 | Utterances []string in plugin comandha.so are OK
678 | Action func in plugin comandha.so is OK
679 | Name string in plugin Home Assistant Control is OK
680 | comandha.so loaded successfully
681 | ```
682 | Then continue on...
683 | ```
684 | Starting webserver at port 8080 (http://localhost:8080)
685 | Starting jdocs pinger ticker
686 | Starting SDK app
687 | Starting server at port 80 for connCheck
688 | Initiating TLS listener, cmux, gRPC handler, and REST handler
689 | Configuration page: http://VECTORIP:8080
690 | Registering escapepod.local on network (loop)
691 | Starting chipper server at port 443
692 | Starting chipper server at port 8084 for 2.0.1 compatibility
693 | wire-pod started successfully!
694 | Jdocs: Incoming ReadDocs request, Robot ID: vic:00######, Item(s) to return:
695 | [doc_name:"vic.AppTokens"]
696 | Successfully got jdocs from 00######
697 | Vector discovered on network, broadcasting mDNS
698 | Broadcasting mDNS now (outside of timer loop)
699 | ```
700 | Then a successful detection and command looks like this ("Hey Vector" pause... "assist turn off the family room lights")
701 | ```
702 | This is a custom intent or plugin!
703 | Bot 00###### request served.
704 | Bot 00###### Stream type: OPUS
705 | (Bot 00######, Vosk) Processing...
706 | Using general recognizer
707 | (Bot 00######) End of speech detected.
708 | Bot 00###### Transcribed text: assist turn off the family room lights
709 | Bot 00###### matched plugin Home Assistant Control, executing function
710 | Bot 00###### plugin Home Assistant Control, response Turned off the lights
711 | ```
712 | Then turn it back on...
713 | ```
714 | This is a custom intent or plugin!
715 | Bot 00###### request served.
716 | Bot 00###### Stream type: OPUS
717 | (Bot 00######, Vosk) Processing...
718 | Using general recognizer
719 | (Bot 00######) End of speech detected.
720 | Bot 00###### Transcribed text: assist turn on the family room lights
721 | Bot 00###### matched plugin Home Assistant Control, executing function
722 | Bot 00###### plugin Home Assistant Control, response Turned on the lights
723 | This is a custom intent or plugin!
724 | Bot 00###### request served.
725 | ```
726 |
727 | 
728 |
729 | Carry on...
730 | ```
731 | Haven't received a conn check from 00###### in 15 seconds, will ping jdocs on next check
732 | Broadcasting mDNS now (outside of timer loop)
733 | Jdocs: Incoming ReadDocs request, Robot ID: vic:00######, Item(s) to return:
734 | [doc_name:"vic.AppTokens"]
735 | Successfully got jdocs from 00######
736 | ```
737 | A failure speech detection should look something like this
738 | ```
739 | (Bot 00######, Vosk) Processing...
740 | Using general recognizer
741 | (Bot 00######) End of speech detected.
742 | Bot 00###### Transcribed text: a third
743 | Not a custom intent
744 | No intent was matched.
745 | Bot 00###### Intent Sent: intent_system_noaudio
746 | No Parameters Sent
747 | Bot 00###### Stream type: OPUS
748 | (Bot 00######, Vosk) Processing...
749 | Using general recognizer
750 | (Bot 00######) End of speech detected.
751 | Bot 00###### Transcribed text: isis to turn off the living room like
752 | Not a custom intent
753 | No intent was matched.
754 | Bot 00###### Intent Sent: intent_system_noaudio
755 | No Parameters Sent
756 | Bot 00###### Stream type: OPUS
757 | (Bot 00######, Vosk) Processing...
758 | Using general recognizer
759 | (Bot 00######) End of speech detected.
760 | Bot 00###### Transcribed text: assist turn off the family room like
761 | Bot 00###### matched plugin Home Assistant Control, executing function
762 | Bot 00###### plugin Home Assistant Control, response Sorry, I couldn't understand that
763 | This is a custom intent or plugin!
764 | Bot 00###### request served.
765 | Bot 00###### Stream type: OPUS
766 | (Bot 00######, Vosk) Processing...
767 | Using general recognizer
768 | (Bot 00######) End of speech detected.
769 | Bot 00###### Transcribed text: assist
770 | Bot 00###### matched plugin Home Assistant Control, executing function
771 | Bot 00###### plugin Home Assistant Control, response Sorry, I couldn't understand that
772 | ```
773 |
774 | ### Using a different Agent ID (HomeLLM) ###
775 | https://github.com/acon96/home-llm
776 | ```
777 | Bot 00###### Stream type: OPUS
778 | (Bot 00######, Vosk) Processing...
779 | Using general recognizer
780 | (Bot 00######) End of speech detected.
781 | Bot 00###### Transcribed text: assist what does the fox say
782 | Bot 00###### matched plugin Home Assistant Control, executing function
783 | Bot 00###### plugin Home Assistant Control, response The fox does not say.
784 | This is a custom intent or plugin!
785 | Bot 00###### request served.
786 | ```
787 |
788 | ## Extra ##
789 |
790 | Automate Vector to say things with his Text-To-Speech engine via HA Automation
791 |
792 | Add your WirePod IP and bot serial number to the 3 lines below.
793 |
794 | configuration.yaml
795 | ```yaml
796 | rest_command:
797 | assume_behavior_control:
798 | url: 'http://10.0.0.111:8080/api-sdk/assume_behavior_control?priority=high&serial=00######'
799 | method: 'get'
800 | say_text:
801 | url: 'http://10.0.0.111:8080/api-sdk/say_text?text={{ textvector }}&serial=00######'
802 | method: 'get'
803 | release_behavior_control:
804 | url: 'http://10.0.0.111:8080/api-sdk/release_behavior_control?priority=high&serial=00######'
805 | method: 'get'
806 | ```
807 |
808 | Automation
809 | ```yaml
810 | alias: Vector Speech
811 | description: Send text to Vector URL
812 | trigger:
813 | - type: opened
814 | platform: device
815 | device_id: somedevice
816 | entity_id: someentity
817 | domain: binary_sensor
818 | condition: []
819 | action:
820 | - service: rest_command.assume_behavior_control
821 | data: {}
822 | - delay: "00:00:01"
823 | - service: rest_command.say_text
824 | data:
825 | textvector: "Your family room lights are off"
826 | - delay: "00:00:10"
827 | - service: rest_command.release_behavior_control
828 | data: {}
829 | mode: single
830 | ```
831 |
832 | ## Useful links ##
833 |
834 | Wire-Pod Go compile information:
835 | https://github.com/kercre123/wire-pod/wiki/For-Developers-and-Tinkerers
836 |
837 | My issue trying to get wire-pod working in docker:
838 | https://github.com/kercre123/wire-pod/issues/201
839 |
840 | Looks like RGarrett93 is priming the ability to have wire-pod as an add-on to HA woo hoo! Help them if you can! I hope what I did does as well!
841 | [https://community.home-assistant.io/t/anki-vector-integration/](https://community.home-assistant.io/t/anki-vector-integration/85156/33)
842 |
843 | 
844 |
845 | **Note:** _I have no idea how I was able to accomplish this! Please feel free to do a PR and make this better if you want and let me know what you did! I just attempted to break ground for others as I'm a basic hacker at best and just really wanted to issue commands to HA through Vector locally instead of using Alexa on him..._
846 |
847 |
849 |