├── .drone.yml ├── .gitignore ├── LICENSE ├── README.md ├── binding.gyp ├── hal_wrapper ├── drivers │ ├── everloop.cpp │ ├── everloop.h │ ├── gpio.cpp │ ├── gpio.h │ ├── info.cpp │ ├── info.h │ └── sensors │ │ ├── humidity.cpp │ │ ├── imu.cpp │ │ ├── pressure.cpp │ │ ├── sensors.h │ │ └── uv.cpp ├── matrix.cpp └── matrix.h ├── index.js ├── lib ├── alsa.js ├── gpio.js └── led.js └── package.json /.drone.yml: -------------------------------------------------------------------------------- 1 | pipeline: 2 | publish-npm: 3 | when: 4 | event: [tag] 5 | image: gcr.io/admobilize-testing/gce-node:06bfcecd 6 | secrets: [npm_token] 7 | commands: 8 | - echo "//registry.npmjs.org/:_authToken=$${NPM_TOKEN}" > /root/.npmrc 9 | - npm publish --scope @matrix-io --access public ./ 10 | 11 | 12 | notify-always: 13 | image: plugins/slack 14 | secrets: [slack_webhook] 15 | username: drone-ci-builder 16 | channel: notifications 17 | when: 18 | status: [ success, failure ] 19 | template: | 20 | {{#success build.status}} 21 | {{build.author}} just built `{{repo.name}}:{{build.branch}}` from <${DRONE_COMMIT_LINK}|#{{truncate build.commit 8}}> 22 | :new: {{build.message}} 23 | {{else}} 24 | {{build.author}} just broke the build of `{{repo.name}}:{{build.branch}}` with <${DRONE_COMMIT_LINK}|#{{truncate build.commit 8}}> 25 | :new: :zombie: {{build.message}} 26 | {{/success}} 27 | :stopwatch: {{ since build.started}} 28 | :gear: {{build.link}} 29 | 30 | notify-new: 31 | when: 32 | event: [tag] 33 | status: success 34 | image: plugins/slack 35 | secrets: [slack_webhook] 36 | username: drone-ci-builder 37 | channel: notifications 38 | template: | 39 | :radioactive_sign: matrix-lite-js NPM package was published. 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .DS_Store 3 | node_modules 4 | ._.DS_Store 5 | build 6 | -------------------------------------------------------------------------------- /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 | # MATRIX-Lite-JS 2 | MATRIX Lite JS is an [npm package](https://www.npmjs.com/package/@matrix-io/matrix-lite) that allows users of varying skill levels to easily program their MATRIX Device. 3 | 4 | 5 | 6 | # Roadmap 7 | - [x] Leds 8 | - [x] Sensors 9 | - [x] IMU 10 | - [x] Humidity 11 | - [x] Pressure 12 | - [x] UV 13 | - [x] GPIO 14 | - [x] Device Info 15 | - [ ] Microphones 16 | - [ ] Hal Mics 17 | - [x] Alsa Mics 18 | - [x] [NFC](https://github.com/matrix-io/matrix-lite-nfc-js) (separate library) 19 | 20 | # Installation 21 | Ensure you have a Raspberry Pi, attached with a MATRIX device, that's flashed with [Raspbian](https://www.raspberrypi.org/blog/raspbian-stretch/). 22 | 23 | ## 1. Install MATRIX HAL 24 | https://matrix-io.github.io/matrix-documentation/matrix-hal/getting-started/installation-package/ 25 | 26 | ## 2. Install Node.js & Create A Project 27 | **Download and install the latest version of Node.js, using [nvm](https://github.com/creationix/nvm) (Node Version Manager)** 28 | ```bash 29 | curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash 30 | . ~/.bashrc 31 | nvm install node 32 | 33 | mkdir myApp 34 | cd myApp 35 | npm init -y 36 | ``` 37 | ## 3. Install matrix-lite-js 38 | ``` 39 | npm install @matrix-io/matrix-lite --save 40 | ``` 41 | 42 | # Usage 43 | ## Everloop 44 | ```js 45 | var matrix = require("@matrix-io/matrix-lite"); 46 | 47 | // Get LED count 48 | console.log("This device has " + matrix.led.length + ' LEDs'); 49 | 50 | // A single string or object sets all LEDs 51 | // Below are different ways of expressing a color (number values are from 0-255) 52 | matrix.led.set('blue'); 53 | matrix.led.set('rgb(0,0,255)'); 54 | matrix.led.set('#0000ff'); 55 | matrix.led.set({r:0, g:0, b:255, w:0}); // objects can set white 56 | 57 | // LEDs off 58 | matrix.led.set('black'); 59 | matrix.led.set([]); 60 | matrix.led.set(); 61 | matrix.led.set({}); 62 | 63 | // Arrays set individual LEDs 64 | matrix.led.set(['red', 'gold', 'purple', {}, 'black', '#6F41C1', 'blue', {g:255}]); 65 | 66 | // Arrays can simulate motion 67 | everloop = new Array(matrix.led.length).fill({}); 68 | everloop[0] = {b:100}; 69 | 70 | setInterval(function(){ 71 | var lastColor = everloop.shift(); 72 | everloop.push(lastColor); 73 | matrix.led.set(everloop); 74 | },50); 75 | ``` 76 | 77 | ## Sensors 78 | ```js 79 | var matrix = require('@matrix-io/matrix-lite'); 80 | 81 | // Sensors will update with each .read() call 82 | var imu, uv, humidity, pressure; 83 | setInterval(function(){ 84 | imu = matrix.imu.read(); 85 | uv = matrix.uv.read(); 86 | humidity = matrix.humidity.read(); 87 | pressure = matrix.pressure.read(); 88 | 89 | console.log(imu, uv, humidity, pressure); 90 | },50); 91 | ``` 92 | 93 | ## GPIO 94 | ```js 95 | var matrix = require('@matrix-io/matrix-lite'); 96 | 97 | // Read GPIO pin 0 (digital) 98 | matrix.gpio.setFunction(0, 'DIGITAL'); 99 | matrix.gpio.setMode(0, 'input'); 100 | console.log(matrix.gpio.getDigital(0)); 101 | 102 | // Set GPIO pin 1 (digital) 103 | matrix.gpio.setFunction(1, 'DIGITAL'); 104 | matrix.gpio.setMode(1, 'output'); 105 | matrix.gpio.setDigital(1, 'ON') 106 | 107 | // Set GPIO pin 2 (PWM) 108 | matrix.gpio.setFunction(2, 'PWM'); 109 | matrix.gpio.setMode(2, 'output'); 110 | matrix.gpio.setPWM({ 111 | pin: 2, 112 | percentage: 25, 113 | frequency: 50 // min 36 114 | }); 115 | 116 | // Set Servo Angle pin 3 117 | matrix.gpio.setFunction(3, 'PWM'); 118 | matrix.gpio.setMode(3, 'output'); 119 | matrix.gpio.setServoAngle({ 120 | pin: 3, 121 | angle: 90, 122 | // minimum pulse width for a PWM wave (in milliseconds) 123 | min_pulse_ms: 0.8 124 | }); 125 | ``` 126 | 127 | ## Info 128 | ```js 129 | var matrix = require("@matrix-io/matrix-lite"); 130 | 131 | // A string of the MATRIX device currently attached 132 | console.log("The " + matrix.info.deviceType + " is attached to the pi"); 133 | 134 | // A boolean that's true, if the kernel modules are not installed 135 | console.log("Are the Kernel Modules installed? " + matrix.info.isDirectBus); 136 | ``` 137 | 138 | ## Alsa 139 | ### Microphone 140 | [npm mic](https://www.npmjs.com/package/mic) is used grab our microphone data from alsa. 141 | ```js 142 | // Record mic input to file 143 | var matrix = require("@matrix-io/matrix-lite"); 144 | var fs = require('fs'); 145 | 146 | var mic = matrix.alsa.mic();// use default settings 147 | var mic = matrix.alsa.mic({ // or configure settings 148 | rate: '16000', 149 | debug: true, 150 | exitOnSilence: 6, 151 | // up to 8 channels 152 | channels: '1' 153 | }); 154 | 155 | // Pipe mic data to file 156 | var micStream = mic.getAudioStream(); 157 | var file = fs.WriteStream('output.raw'); 158 | micStream.pipe(file); 159 | 160 | micStream.on('startComplete', function() { 161 | setTimeout(mic.stop, 5000); 162 | }); 163 | 164 | mic.start(); 165 | ``` 166 | 167 | # Building Locally For Development 168 | If you want to contribute to matrix-lite-js, below are the steps to build locally. Each step should take place on your Raspberry Pi. 169 | 170 | Have MATRIX HAL installed 171 | 172 | https://matrix-io.github.io/matrix-documentation/matrix-hal/getting-started/installation-package/ 173 | 174 | Download the matrix-lite-js repository 175 | ```bash 176 | git clone https://github.com/matrix-io/matrix-lite-js 177 | ``` 178 | 179 | Install Node.js 180 | ```bash 181 | curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash 182 | . ~/.bashrc 183 | nvm install 11.0.0 184 | ``` 185 | 186 | Install Node.js dependencies 187 | ```bash 188 | npm install 189 | ``` 190 | 191 | From this point, you can treat the repository as a normal module. Any Node.js script can include it. 192 | ```js 193 | var matrix = require('PATH_TO_FOLDER/matrix-lite-js') 194 | ``` 195 | 196 | If you need to edit any C++ files in the `hal-wrapper` folder, use the following to compile your changes. 197 | ```bash 198 | npm run build 199 | ``` 200 | -------------------------------------------------------------------------------- /binding.gyp: -------------------------------------------------------------------------------- 1 | { 2 | "targets": [ 3 | { 4 | "include_dirs": [ 5 | " 2 | #include "everloop.h" 3 | #include "../matrix.h" 4 | #include "matrix_hal/everloop.h" 5 | #include "matrix_hal/everloop_image.h" 6 | #include 7 | 8 | // - Number of LEDs on MATRIX device 9 | int ledCount = bus.MatrixLeds(); 10 | 11 | // create empty everloop image with size of ledCount 12 | matrix_hal::EverloopImage everloop_image(ledCount); 13 | // create Everloop object 14 | matrix_hal::Everloop everloop; 15 | 16 | // - Set LED states 17 | // Paramters: Array of size ledCount with objects that have RGBW values. 18 | NAN_METHOD(Set){ 19 | // if array argument is not given, throw error 20 | if (!info[0]->IsArray()) {Nan::ThrowTypeError("Argument must be an array");return;} 21 | 22 | // grab array of LEDs objects 23 | v8::Local leds = v8::Local::Cast(info[0]); 24 | 25 | // read RGBW properties of each LED 26 | int red, green, blue, white; 27 | for (uint i = 0; i < leds->Length(); i++) { 28 | // grab LED object properties 29 | v8::Local readLed = Nan::Get(leds, i).ToLocalChecked(); 30 | v8::Local newLed = Nan::To(readLed).ToLocalChecked(); 31 | 32 | v8::Local redProp = Nan::New("red").ToLocalChecked(); 33 | v8::Local greenProp = Nan::New("green").ToLocalChecked(); 34 | v8::Local blueProp = Nan::New("blue").ToLocalChecked(); 35 | v8::Local whiteProp = Nan::New("white").ToLocalChecked(); 36 | 37 | // grab RGBW values 38 | red = Nan::To(Nan::Get(newLed, redProp).ToLocalChecked()).FromJust(); 39 | green = Nan::To(Nan::Get(newLed, greenProp).ToLocalChecked()).FromJust(); 40 | blue = Nan::To(Nan::Get(newLed, blueProp).ToLocalChecked()).FromJust(); 41 | white = Nan::To(Nan::Get(newLed, whiteProp).ToLocalChecked()).FromJust(); 42 | 43 | // set new LED state 44 | everloop_image.leds[i].red = red; 45 | everloop_image.leds[i].green = green; 46 | everloop_image.leds[i].blue = blue; 47 | everloop_image.leds[i].white = white; 48 | } 49 | 50 | // Updates the Everloop on the MATRIX device 51 | everloop.Write(&everloop_image); 52 | } 53 | 54 | // ** EXPORTED LED OBJECT ** // 55 | NAN_METHOD(led) { 56 | // Set everloop to use MatrixIOBus bus 57 | everloop.Setup(&bus); 58 | 59 | // Create object 60 | v8::Local obj = Nan::New(); 61 | 62 | // Set Object Properties // 63 | // # of MATRIX LEDs 64 | Nan::Set(obj, Nan::New("length").ToLocalChecked(), Nan::New(ledCount)); 65 | 66 | // LED set method 67 | Nan::Set(obj, Nan::New("set").ToLocalChecked(), 68 | Nan::GetFunction(Nan::New(Set)).ToLocalChecked()); 69 | 70 | // Return object 71 | info.GetReturnValue().Set(obj); 72 | } -------------------------------------------------------------------------------- /hal_wrapper/drivers/everloop.h: -------------------------------------------------------------------------------- 1 | #ifndef EVERLOOP_H 2 | #define EVERLOOP_H 3 | 4 | #include 5 | 6 | NAN_METHOD(led); 7 | 8 | #endif -------------------------------------------------------------------------------- /hal_wrapper/drivers/gpio.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../matrix.h" 3 | #include "gpio.h" 4 | #include "matrix_hal/gpio_control.h" 5 | #include 6 | #include 7 | 8 | // Create GPIOControl object 9 | matrix_hal::GPIOControl gpio_control; 10 | 11 | // - Set GPIO Pin state (digital) 12 | // Paramters: int pin (0-15), int mode (0=INPUT or 1=OUTPUT) 13 | NAN_METHOD(SetMode){ 14 | // if argument 1 & 2 are not a number, throw error 15 | if (!info[0]->IsNumber() && !info[1]->IsNumber()) {Nan::ThrowTypeError("Arguments 1 & 2 must be a number");return;} 16 | // get user arguments 17 | int pin = Nan::To(info[0]).FromJust(); 18 | int mode = Nan::To(info[1]).FromJust(); 19 | 20 | // if argument 2 is not 0 (INPUT) or 1 (OUTPUT), throw error 21 | if (mode != 1 && mode != 0){Nan::ThrowTypeError("Argument 2 must be 0 or 1");return;} 22 | // set pin to desired INPUT/OUTPUT mode 23 | gpio_control.SetMode(pin, mode); 24 | } 25 | 26 | // - Set GPIO Pin function 27 | // Parameters: int pin (0-15), int function (0=DIGITAL or 1=PWM) 28 | NAN_METHOD(SetFunction){ 29 | // if argument 1 & 2 are not a number, throw error 30 | if (!info[0]->IsNumber() && !info[1]->IsNumber()) {Nan::ThrowTypeError("Arguments 1 & 2 must be a number");return;} 31 | 32 | // get user arguments 33 | int pin = Nan::To(info[0]).FromJust(); 34 | int pinFunction = Nan::To(info[1]).FromJust(); 35 | 36 | // if argument 2 is not 0 (DIGITAL) or 1 (PWM), throw error 37 | if (pinFunction != 1 && pinFunction != 0){Nan::ThrowTypeError("Argument 2 must be 0 or 1");return;} 38 | 39 | gpio_control.SetFunction(pin, pinFunction); 40 | } 41 | 42 | // - Set GPIO Pin PWM 43 | // Parameters: float frequency, float percentage, int pin (0-15) 44 | NAN_METHOD(SetPWM){ 45 | // for each required argument 46 | int args = 3; 47 | for(int i = 0; i < args; i++){ 48 | // if argument is not a number, throw error 49 | if (!info[i]->IsNumber()){Nan::ThrowTypeError("Arguments must be a number");return;} 50 | } 51 | 52 | // get user arguments 53 | float frequency = Nan::To(info[0]).FromJust(); 54 | float percentage = Nan::To(info[1]).FromJust(); 55 | uint16_t pin = Nan::To(info[2]).FromJust(); 56 | 57 | // std::cout << "frequency: " << frequency << std::endl; 58 | // std::cout << "percentage: " << percentage << std::endl; 59 | // std::cout << "pin: " << pin << std::endl; 60 | 61 | // set PWM output 62 | gpio_control.SetPWM(frequency, percentage, pin); 63 | } 64 | 65 | // - Set Servo angle through PWM 66 | // Parameters: float angle, float min_pulse_ms, int pin (0-15) 67 | NAN_METHOD(SetServoAngle){ 68 | // for each required argument 69 | int args = 3; 70 | for(int i = 0; i < args; i++){ 71 | // if argument is not a number, throw error 72 | if (!info[i]->IsNumber()){Nan::ThrowTypeError("Arguments must be a number");return;} 73 | } 74 | 75 | // get user arguments 76 | float angle = Nan::To(info[0]).FromJust(); 77 | float min_pulse_ms = Nan::To(info[1]).FromJust(); 78 | uint16_t pin = Nan::To(info[2]).FromJust(); 79 | 80 | // std::cout << "pin: " << pin << std::endl; 81 | // std::cout << "angle: " << angle << std::endl; 82 | // std::cout << "min_pulse_ms: " << min_pulse_ms << std::endl; 83 | 84 | // set PWM output 85 | gpio_control.SetServoAngle(angle, min_pulse_ms, pin); 86 | } 87 | 88 | // - Read GPIO Pin state (digital only) 89 | NAN_METHOD(GetValue){ 90 | // if first argument is not a number, throw error 91 | if (!info[0]->IsNumber()) {Nan::ThrowTypeError("Argument must be a number");return;} 92 | // get user arguments 93 | uint16_t pinValue = gpio_control.GetGPIOValue(Nan::To(info[0]).FromJust()); 94 | // return desired pin's value 95 | info.GetReturnValue().Set(pinValue); 96 | } 97 | 98 | // - Set GPIO Pin state (digital) 99 | // Paramters: int pin (0-15), int PinState (0-1) 100 | NAN_METHOD(SetDigital){ 101 | // if argument 1 & 2 are not a number, throw error 102 | if (!info[0]->IsNumber() && !info[1]->IsNumber()) {Nan::ThrowTypeError("Argument 1 & 2 must be a number");return;} 103 | // get user arguments 104 | int pin = Nan::To(info[0]).FromJust(); 105 | int digitalState = Nan::To(info[1]).FromJust(); 106 | 107 | // if argument 2 is not 0 (OFF) or 1 (ON), throw error 108 | if (digitalState != 1 && digitalState != 0){Nan::ThrowTypeError("Argument 2 must be 0 or 1");return;} 109 | 110 | // set pin to desired value 111 | gpio_control.SetGPIOValue(pin, digitalState); 112 | } 113 | 114 | ///////////////////////////////// 115 | // ** EXPORTED GPIO OBJECT ** // 116 | NAN_METHOD(gpio) { 117 | // Set gpio to use MatrixIOBus bus 118 | gpio_control.Setup(&bus); 119 | // Create object 120 | v8::Local obj = Nan::New(); 121 | 122 | // Set Object Properties // 123 | // GPIO set mode method 124 | Nan::Set(obj, Nan::New("setMode").ToLocalChecked(), 125 | Nan::GetFunction(Nan::New(SetMode)).ToLocalChecked()); 126 | // GPIO set function method 127 | Nan::Set(obj, Nan::New("setFunction").ToLocalChecked(), 128 | Nan::GetFunction(Nan::New(SetFunction)).ToLocalChecked()); 129 | 130 | // read method (Digital only) 131 | Nan::Set(obj, Nan::New("getValue").ToLocalChecked(), 132 | Nan::GetFunction(Nan::New(GetValue)).ToLocalChecked()); 133 | // set method (Digital only) 134 | Nan::Set(obj, Nan::New("setDigital").ToLocalChecked(), 135 | Nan::GetFunction(Nan::New(SetDigital)).ToLocalChecked()); 136 | 137 | // PWM set output method 138 | Nan::Set(obj, Nan::New("setPWM").ToLocalChecked(), 139 | Nan::GetFunction(Nan::New(SetPWM)).ToLocalChecked()); 140 | 141 | // PWM set output method 142 | Nan::Set(obj, Nan::New("setServoAngle").ToLocalChecked(), 143 | Nan::GetFunction(Nan::New(SetServoAngle)).ToLocalChecked()); 144 | 145 | // Return object 146 | info.GetReturnValue().Set(obj); 147 | } 148 | -------------------------------------------------------------------------------- /hal_wrapper/drivers/gpio.h: -------------------------------------------------------------------------------- 1 | #ifndef GPIO_H 2 | #define GPIO_H 3 | 4 | #include 5 | 6 | NAN_METHOD(gpio); 7 | 8 | #endif -------------------------------------------------------------------------------- /hal_wrapper/drivers/info.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../matrix.h" 3 | #include "info.h" 4 | #include 5 | 6 | // Detect if using bus or kernel modules 7 | bool isDirectBus = bus.IsDirectBus() ? true : false; 8 | 9 | // Get the name of the MATRIX device being used 10 | std::string getDeviceType() { 11 | if (bus.MatrixName() == matrix_hal::kMatrixCreator) 12 | return "MATRIX Creator"; 13 | else if (bus.MatrixName() == matrix_hal::kMatrixVoice) 14 | return "MATRIX Voice"; 15 | else 16 | return "DEVICE NOT RECOGNIZED"; 17 | } 18 | 19 | std::string deviceType = getDeviceType(); 20 | 21 | /////////////////////////////////////// 22 | // ** EXPORTED DEVICE INFO OBJECT ** // 23 | NAN_METHOD(info) { 24 | // Create object 25 | v8::Local obj = Nan::New(); 26 | 27 | // Set Object Properties // 28 | Nan::Set(obj, Nan::New("isDirectBus").ToLocalChecked(), Nan::New(isDirectBus)); 29 | Nan::Set(obj, Nan::New("deviceType").ToLocalChecked(), Nan::New(deviceType).ToLocalChecked()); 30 | 31 | // Return object 32 | info.GetReturnValue().Set(obj); 33 | } 34 | -------------------------------------------------------------------------------- /hal_wrapper/drivers/info.h: -------------------------------------------------------------------------------- 1 | #ifndef INFO_H 2 | #define INFO_H 3 | 4 | #include 5 | 6 | NAN_METHOD(info); 7 | 8 | #endif -------------------------------------------------------------------------------- /hal_wrapper/drivers/sensors/humidity.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../../matrix.h" 3 | #include "sensors.h" 4 | #include "matrix_hal/humidity_sensor.h" 5 | #include "matrix_hal/humidity_data.h" 6 | #include 7 | 8 | // Create humidity Data object 9 | matrix_hal::HumidityData humidity_data; 10 | // Create humidity Sensor object 11 | matrix_hal::HumiditySensor humidity_sensor; 12 | 13 | NAN_METHOD(ReadHumidity){ 14 | // Overwrites humidity_data with new data from humidity sensor 15 | humidity_sensor.Read(&humidity_data); 16 | 17 | // Create Humidity data object // 18 | v8::Local obj = Nan::New(); 19 | // Get/Set object properties 20 | Nan::Set(obj, Nan::New("humidity").ToLocalChecked(), Nan::New(humidity_data.humidity));// Humidity represented in % 21 | Nan::Set(obj, Nan::New("temperature").ToLocalChecked(), Nan::New(humidity_data.temperature));// Temperature represented in °C 22 | 23 | // Return object 24 | info.GetReturnValue().Set(obj); 25 | } 26 | 27 | // ** EXPORTED HUMIDITY OBJECT ** // 28 | NAN_METHOD(humidity) { 29 | // Set humidity_sensor to use MatrixIOBus bus 30 | humidity_sensor.Setup(&bus); 31 | 32 | // Create Humidity object 33 | v8::Local obj = Nan::New(); 34 | 35 | // Set Object Properties // 36 | // Read humidity method 37 | Nan::Set(obj, Nan::New("read").ToLocalChecked(), 38 | Nan::GetFunction(Nan::New(ReadHumidity)).ToLocalChecked()); 39 | 40 | // Return object 41 | info.GetReturnValue().Set(obj); 42 | } -------------------------------------------------------------------------------- /hal_wrapper/drivers/sensors/imu.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../../matrix.h" 3 | #include "sensors.h" 4 | #include "matrix_hal/imu_sensor.h" 5 | #include "matrix_hal/imu_data.h" 6 | #include 7 | 8 | // Create IMU Data object 9 | matrix_hal::IMUData imu_data; 10 | // Create IMU Sensor object 11 | matrix_hal::IMUSensor imu_sensor; 12 | 13 | NAN_METHOD(ReadIMU){ 14 | // Overwrites imu_data with new data from IMU sensor 15 | imu_sensor.Read(&imu_data); 16 | 17 | // Create IMU data object // 18 | v8::Local obj = Nan::New(); 19 | // Accelerometer data 20 | Nan::Set(obj, Nan::New("accel_x").ToLocalChecked(), Nan::New(imu_data.accel_x)); 21 | Nan::Set(obj, Nan::New("accel_y").ToLocalChecked(), Nan::New(imu_data.accel_y)); 22 | Nan::Set(obj, Nan::New("accel_z").ToLocalChecked(), Nan::New(imu_data.accel_z)); 23 | // Gyroscope data 24 | Nan::Set(obj, Nan::New("gyro_x").ToLocalChecked(), Nan::New(imu_data.gyro_x)); 25 | Nan::Set(obj, Nan::New("gyro_y").ToLocalChecked(), Nan::New(imu_data.gyro_y)); 26 | Nan::Set(obj, Nan::New("gyro_z").ToLocalChecked(), Nan::New(imu_data.gyro_z)); 27 | // Yaw, Pitch & Roll data 28 | Nan::Set(obj, Nan::New("yaw").ToLocalChecked(), Nan::New(imu_data.yaw)); 29 | Nan::Set(obj, Nan::New("pitch").ToLocalChecked(), Nan::New(imu_data.pitch)); 30 | Nan::Set(obj, Nan::New("roll").ToLocalChecked(), Nan::New(imu_data.roll)); 31 | // Magnetometer Output 32 | Nan::Set(obj, Nan::New("mag_x").ToLocalChecked(), Nan::New(imu_data.mag_x)); 33 | Nan::Set(obj, Nan::New("mag_y").ToLocalChecked(), Nan::New(imu_data.mag_y)); 34 | Nan::Set(obj, Nan::New("mag_z").ToLocalChecked(), Nan::New(imu_data.mag_z)); 35 | 36 | // Return object 37 | info.GetReturnValue().Set(obj); 38 | } 39 | 40 | // ** EXPORTED IMU OBJECT ** // 41 | NAN_METHOD(imu) { 42 | // Set imu_sensor to use MatrixIOBus bus 43 | imu_sensor.Setup(&bus); 44 | 45 | // Create IMU object 46 | v8::Local obj = Nan::New(); 47 | 48 | // Set Object Properties // 49 | // Read IMU method 50 | Nan::Set(obj, Nan::New("read").ToLocalChecked(), 51 | Nan::GetFunction(Nan::New(ReadIMU)).ToLocalChecked()); 52 | 53 | // Return object 54 | info.GetReturnValue().Set(obj); 55 | } -------------------------------------------------------------------------------- /hal_wrapper/drivers/sensors/pressure.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../../matrix.h" 3 | #include "sensors.h" 4 | #include "matrix_hal/pressure_sensor.h" 5 | #include "matrix_hal/pressure_data.h" 6 | #include 7 | 8 | // Create pressure Data object 9 | matrix_hal::PressureData pressure_data; 10 | // Create pressure Sensor object 11 | matrix_hal::PressureSensor pressure_sensor; 12 | 13 | NAN_METHOD(ReadPressure){ 14 | // Overwrites pressure_data with new data from pressure sensor 15 | pressure_sensor.Read(&pressure_data); 16 | 17 | // Create Pressure data object // 18 | v8::Local obj = Nan::New(); 19 | // Get/Set object properties 20 | Nan::Set(obj, Nan::New("altitude").ToLocalChecked(), Nan::New(pressure_data.altitude));// Altitude represented in meters 21 | Nan::Set(obj, Nan::New("pressure").ToLocalChecked(), Nan::New(pressure_data.pressure));// Pressure represented in kPa 22 | Nan::Set(obj, Nan::New("temperature").ToLocalChecked(), Nan::New(pressure_data.temperature));// Temperature represented in °C 23 | 24 | // Return object 25 | info.GetReturnValue().Set(obj); 26 | } 27 | 28 | // ** EXPORTED PRESSURE OBJECT ** // 29 | NAN_METHOD(pressure) { 30 | // Set pressure_sensor to use MatrixIOBus bus 31 | pressure_sensor.Setup(&bus); 32 | 33 | // Create Pressure object 34 | v8::Local obj = Nan::New(); 35 | 36 | // Set Object Properties // 37 | // Read pressure method 38 | Nan::Set(obj, Nan::New("read").ToLocalChecked(), 39 | Nan::GetFunction(Nan::New(ReadPressure)).ToLocalChecked()); 40 | 41 | // Return object 42 | info.GetReturnValue().Set(obj); 43 | } -------------------------------------------------------------------------------- /hal_wrapper/drivers/sensors/sensors.h: -------------------------------------------------------------------------------- 1 | #ifndef SENSORS_SENSOR_H 2 | #define SENSORS_SENSOR_H 3 | 4 | #include 5 | 6 | NAN_METHOD(pressure); 7 | NAN_METHOD(humidity); 8 | NAN_METHOD(uv); 9 | NAN_METHOD(imu); 10 | 11 | #endif -------------------------------------------------------------------------------- /hal_wrapper/drivers/sensors/uv.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../../matrix.h" 3 | #include "sensors.h" 4 | #include "matrix_hal/uv_sensor.h" 5 | #include "matrix_hal/uv_data.h" 6 | #include 7 | 8 | // Create UV Data object 9 | matrix_hal::UVData uv_data; 10 | // Create UV Sensor object 11 | matrix_hal::UVSensor uv_sensor; 12 | 13 | NAN_METHOD(ReadUV){ 14 | // Overwrites uv_data with new data from uv sensor 15 | uv_sensor.Read(&uv_data); 16 | 17 | // Create UV data object // 18 | v8::Local obj = Nan::New(); 19 | // Get/Set object properties 20 | Nan::Set(obj, Nan::New("uv").ToLocalChecked(), Nan::New(uv_data.uv));// UV represented in UV Index 21 | 22 | // Return object 23 | info.GetReturnValue().Set(obj); 24 | } 25 | 26 | // ** EXPORTED UV OBJECT ** // 27 | NAN_METHOD(uv) { 28 | // Set uv_sensor to use MatrixIOBus bus 29 | uv_sensor.Setup(&bus); 30 | 31 | // Create UV object 32 | v8::Local obj = Nan::New(); 33 | 34 | // Set Object Properties // 35 | // Read UV method 36 | Nan::Set(obj, Nan::New("read").ToLocalChecked(), 37 | Nan::GetFunction(Nan::New(ReadUV)).ToLocalChecked()); 38 | 39 | // Return object 40 | info.GetReturnValue().Set(obj); 41 | } -------------------------------------------------------------------------------- /hal_wrapper/matrix.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "matrix.h" 3 | #include "drivers/everloop.h" 4 | #include "drivers/gpio.h" 5 | #include "drivers/info.h" 6 | #include "drivers/sensors/sensors.h" 7 | 8 | // Initialize bus for MATRIX hardware communication 9 | matrix_hal::MatrixIOBus bus; 10 | bool busReady = bus.Init(); 11 | 12 | // Node addon entry point 13 | NAN_MODULE_INIT(Initialize){ 14 | // Throw error if MATRIX bus is not setup 15 | if (!busReady) return Nan::ThrowError(Nan::New("matrixio_bus not initialized!\nIs MATRIX HAL installed?").ToLocalChecked()); 16 | 17 | // Export functions that return JS objects 18 | NAN_EXPORT(target, led); 19 | NAN_EXPORT(target, gpio); 20 | NAN_EXPORT(target, imu); 21 | NAN_EXPORT(target, humidity); 22 | NAN_EXPORT(target, pressure); 23 | NAN_EXPORT(target, uv); 24 | NAN_EXPORT(target, info); 25 | } 26 | 27 | // Create a Node module called "addon" and pass the entry point function. 28 | NODE_MODULE(addon, Initialize); -------------------------------------------------------------------------------- /hal_wrapper/matrix.h: -------------------------------------------------------------------------------- 1 | #ifndef MATRIX_H 2 | #define MATRIX_H 3 | 4 | #include "matrix_hal/matrixio_bus.h" 5 | 6 | // Global object for MATRIX hardware communication 7 | extern matrix_hal::MatrixIOBus bus; 8 | 9 | #endif -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | hal = require('./build/Release/addon'); 2 | hal.info = hal.info(); 3 | 4 | var led = require('./lib/led.js'); 5 | var gpio = require('./lib/gpio.js'); 6 | var alsa = require('./lib/alsa.js'); 7 | 8 | // - final module exports 9 | function exported(){ 10 | var matrixLite = { 11 | 'led': led, 12 | 'gpio': gpio, 13 | 'alsa': alsa, 14 | 'imu': hal.imu(), 15 | 'humidity': hal.humidity(), 16 | 'pressure': hal.pressure(), 17 | 'uv': hal.uv(), 18 | 'info': hal.info 19 | } 20 | 21 | return matrixLite; 22 | } 23 | 24 | module.exports = exported(); -------------------------------------------------------------------------------- /lib/alsa.js: -------------------------------------------------------------------------------- 1 | var mic = require('mic');// Requires matrix kernel module to work 2 | var loudness = require('loudness'); 3 | 4 | // exported object 5 | var alsa = { 6 | 'setVolume': loudness.setVolume, 7 | 'getVolume': loudness.getVolume, 8 | 'mute': loudness.setMuted, 9 | ///*not working*/ 'isMuted': loudness.getMuted 10 | }; 11 | 12 | // mic initialization function 13 | alsa.mic = function(config={}){ 14 | // If kernel modules are not installed 15 | if(hal.info.isDirectBus){ 16 | throw Error('Cannot use Alsa mic without MATRIX Kernel Modules!\n' 17 | +'\x1b[35mYou can install them with:\x1b[0m\n' 18 | +'\x1b[33msudo apt install matrixio-kernel-modules\x1b[0m\n' 19 | +'\x1b[33msudo reboot\x1b[0m\n'); 20 | } 21 | 22 | config = { 23 | // Set default values for any missing configs 24 | rate: config.rate !== undefined ? config.rate : 16000, 25 | debug: config.debug !== undefined ? config.debug : false, 26 | endian: config.endian !== undefined ? config.endian : 'little', 27 | bitwidth: config.bitwidth !== undefined ? config.bitwidth : 16, 28 | exitOnSilence: config.exitOnSilence !== undefined ? config.exitOnSilence : 0, 29 | device: config.device !== undefined ? config.device : 'hw:2,0', 30 | channels: config.channels !== undefined ? config.channels : 1,// 8 channels total 31 | } 32 | 33 | return mic(config); 34 | } 35 | 36 | module.exports = alsa; 37 | -------------------------------------------------------------------------------- /lib/gpio.js: -------------------------------------------------------------------------------- 1 | var gpio = hal.gpio(); 2 | 3 | // - Set a pin as input or output 4 | function setMode(pin, mode){ 5 | if(mode === 0 || mode.toString().toLowerCase() === 'input') 6 | mode = 0; 7 | else if(mode === 1 || mode.toString().toLowerCase() === 'output') 8 | mode = 1; 9 | else 10 | throw Error('Did not specify mode as "input" or "output"\n'); 11 | 12 | gpio.setMode(pin, mode); 13 | } 14 | 15 | // - Set a pin as I/O or PWM 16 | function setFunction(pin, mode){ 17 | if(mode === 0 || mode.toString().toLowerCase() === 'digital') 18 | mode = 0; 19 | else if(mode === 1 || mode.toString().toLowerCase() === 'pwm') 20 | mode = 1; 21 | else 22 | throw Error('Did not specify mode as "I/O" or "PWM"\n'); 23 | 24 | gpio.setFunction(pin, mode); 25 | } 26 | 27 | // - Read digital pin value 28 | function getDigital(pin){ 29 | return gpio.getValue(pin); 30 | } 31 | 32 | // - Set digital pin value 33 | function setDigital(pin, mode){ 34 | if(mode === 0 || mode.toString().toLowerCase() === 'off') 35 | mode = 0; 36 | else if(mode === 1 || mode.toString().toLowerCase() === 'on') 37 | mode = 1; 38 | else 39 | throw Error('Did not specify value as "on" or "off"\n'); 40 | 41 | return gpio.setDigital(pin, mode); 42 | } 43 | 44 | // - Set Servo Angle 45 | function setServoAngle(config){ 46 | // min_pulse_ms is the minimum pulse width for a PWM wave in milliseconds 47 | return gpio.setServoAngle(config.angle, config.min_pulse_ms, config.pin); 48 | } 49 | 50 | // - Set PWM value 51 | function setPWM(config){ 52 | return gpio.setPWM(config.frequency, config.percentage, config.pin); 53 | } 54 | 55 | module.exports = { 56 | "setMode": function(pin, mode){ 57 | setMode(pin, mode); 58 | }, 59 | "setFunction": function(pin, mode){ 60 | setFunction(pin, mode); 61 | }, 62 | "getDigital": function(pin){ 63 | return getDigital(pin); 64 | }, 65 | "setDigital": function(pin, mode){ 66 | return setDigital(pin, mode); 67 | }, 68 | "setPWM": function(config){ 69 | return setPWM(config); 70 | }, 71 | "setServoAngle": function(config){ 72 | return setServoAngle(config); 73 | } 74 | }; 75 | -------------------------------------------------------------------------------- /lib/led.js: -------------------------------------------------------------------------------- 1 | var Color = require('color'); 2 | var led = hal.led(); 3 | 4 | // - Set each everloop LED 5 | function set(config){ 6 | var everloop = []; 7 | 8 | // If valid array, fill everloop 9 | if (Array.isArray(config)){ 10 | 11 | // catch invalid array lengths 12 | if (config.length > led.length) 13 | throw Error('You set '+config.length+' LEDs when your MATRIX device only has '+led.length+'\n'); 14 | 15 | // set led values & set undefined values as 'black' 16 | everloop = new Array(led.length); 17 | for (var i = 0; i < led.length; i++){ 18 | everloop[i] = (config[i] === undefined) ? {} : readColor(config[i]); 19 | } 20 | 21 | led.set(everloop); 22 | return; 23 | } 24 | 25 | // Else set everloop as one color 26 | everloop = new Array(led.length).fill(readColor(config)); 27 | led.set(everloop); 28 | } 29 | 30 | // - Return an RGB(W) value from a string or object 31 | function readColor(color){ 32 | var ledSetting = {red: 0, green: 0, blue: 0} 33 | 34 | if (color === undefined || color.constructor == Object){ 35 | color = new Object(color); 36 | 37 | // If color given, set. else set as 0 38 | ledSetting.red = (color.r) ? color.r : 0; 39 | ledSetting.green = (color.g) ? color.g : 0; 40 | ledSetting.blue = (color.b) ? color.b : 0; 41 | ledSetting.white = (color.w) ? color.w : 0; 42 | } 43 | 44 | else if (color.constructor == String){ 45 | // parse string into rgb format 46 | color = Color(color); 47 | ledSetting.red = color.red(); 48 | ledSetting.green = color.green(); 49 | ledSetting.blue = color.blue(); 50 | } 51 | 52 | else { 53 | throw Error( 54 | 'LED configuration must be an object, string, or array\n' 55 | +'Invalid Input: '+color+'\n' 56 | +'examples:\n' 57 | +'\tled.set(["green", "rgb(0,255,0)", "#008000", {g:250}]);\n' 58 | +'\tled.set("purple");\n'); 59 | } 60 | 61 | return ledSetting; 62 | } 63 | 64 | module.exports = { 65 | "set": function(everloop){ 66 | set(everloop); 67 | }, 68 | "length": led.length 69 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@matrix-io/matrix-lite", 3 | "version": "0.4.6", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "build": "node-gyp rebuild", 8 | "test": "node-gyp rebuild && node index.js" 9 | }, 10 | "gypfile": true, 11 | "keywords": [], 12 | "build": "node-gyp rebuild && node index.js", 13 | "author": "", 14 | "license": "ISC", 15 | "dependencies": { 16 | "color": "^3.1.0", 17 | "loudness": "^0.3.0", 18 | "mic": "^2.1.2", 19 | "nan": "^2.14.0", 20 | "node-gyp": "^4.0.0" 21 | } 22 | } 23 | --------------------------------------------------------------------------------