diff --git a/.gitignore b/.gitignore index c83f8b7..9647e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ @@ -8,4 +12,4 @@ bundles *.DS_Store .eggs dist -**/*.egg-info \ No newline at end of file +**/*.egg-info diff --git a/.pylintrc b/.pylintrc index 21de8ac..622f205 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst b/README.rst index 31f865c..838f202 100644 --- a/README.rst +++ b/README.rst @@ -64,8 +64,8 @@ To install in a virtual environment in your current project: Usage Example ============= See examples/rfm69_simpletest.py for a simple demo of the usage. -Note: the default baudrate for the SPI is 2000000 (2MHz). -The maximum setting is 10Mhz but +Note: the default baudrate for the SPI is 2000000 (2MHz). +The maximum setting is 10Mhz but transmission errors have been observed expecially when using breakout boards. For breakout boards or other configurations where the boards are separated, it may be necessary to reduce the baudrate for reliable data transmission. diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_rfm69.py b/adafruit_rfm69.py index 1655188..b8ec63b 100644 --- a/adafruit_rfm69.py +++ b/adafruit_rfm69.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2017 Tony DiCola for Adafruit Industries # -# Copyright (c) 2017 Tony DiCola for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_rfm69` ==================================================== @@ -431,7 +414,7 @@ def sleep(self): def listen(self): """Listen for packets to be received by the chip. Use :py:func:`receive` to listen, wait - and retrieve packets as they're available. + and retrieve packets as they're available. """ # Like RadioHead library, turn off high power boost if enabled. if self._tx_power >= 18: @@ -444,8 +427,8 @@ def listen(self): def transmit(self): """Transmit a packet which is queued in the FIFO. This is a low level function for - entering transmit mode and more. For generating and transmitting a packet of data use - :py:func:`send` instead. + entering transmit mode and more. For generating and transmitting a packet of data use + :py:func:`send` instead. """ # Like RadioHead library, turn on high power boost if enabled. if self._tx_power >= 18: @@ -459,9 +442,9 @@ def transmit(self): @property def temperature(self): """The internal temperature of the chip in degrees Celsius. Be warned this is not - calibrated or very accurate. + calibrated or very accurate. - .. warning:: Reading this will STOP any receiving/sending that might be happening! + .. warning:: Reading this will STOP any receiving/sending that might be happening! """ # Start a measurement then poll the measurement finished bit. self.temp_start = 1 @@ -475,9 +458,9 @@ def temperature(self): @property def operation_mode(self): """The operation mode value. Unless you're manually controlling the chip you shouldn't - change the operation_mode with this property as other side-effects are required for - changing logical modes--use :py:func:`idle`, :py:func:`sleep`, :py:func:`transmit`, - :py:func:`listen` instead to signal intent for explicit logical modes. + change the operation_mode with this property as other side-effects are required for + changing logical modes--use :py:func:`idle`, :py:func:`sleep`, :py:func:`transmit`, + :py:func:`listen` instead to signal intent for explicit logical modes. """ op_mode = self._read_u8(_REG_OP_MODE) return (op_mode >> 2) & 0b111 @@ -497,10 +480,10 @@ def operation_mode(self, val): @property def sync_word(self): """The synchronization word value. This is a byte string up to 8 bytes long (64 bits) - which indicates the synchronization word for transmitted and received packets. Any - received packet which does not include this sync word will be ignored. The default value - is 0x2D, 0xD4 which matches the RadioHead RFM69 library. Setting a value of None will - disable synchronization word matching entirely. + which indicates the synchronization word for transmitted and received packets. Any + received packet which does not include this sync word will be ignored. The default value + is 0x2D, 0xD4 which matches the RadioHead RFM69 library. Setting a value of None will + disable synchronization word matching entirely. """ # Handle when sync word is disabled.. if not self.sync_on: @@ -529,8 +512,8 @@ def sync_word(self, val): @property def preamble_length(self): """The length of the preamble for sent and received packets, an unsigned 16-bit value. - Received packets must match this length or they are ignored! Set to 4 to match the - RadioHead RFM69 library. + Received packets must match this length or they are ignored! Set to 4 to match the + RadioHead RFM69 library. """ msb = self._read_u8(_REG_PREAMBLE_MSB) lsb = self._read_u8(_REG_PREAMBLE_LSB) @@ -545,7 +528,7 @@ def preamble_length(self, val): @property def frequency_mhz(self): """The frequency of the radio in Megahertz. Only the allowed values for your radio must be - specified (i.e. 433 vs. 915 mhz)! + specified (i.e. 433 vs. 915 mhz)! """ # FRF register is computed from the frequency following the datasheet. # See section 6.2 and FRF register description. @@ -573,9 +556,9 @@ def frequency_mhz(self, val): @property def encryption_key(self): """The AES encryption key used to encrypt and decrypt packets by the chip. This can be set - to None to disable encryption (the default), otherwise it must be a 16 byte long byte - string which defines the key (both the transmitter and receiver must use the same key - value). + to None to disable encryption (the default), otherwise it must be a 16 byte long byte + string which defines the key (both the transmitter and receiver must use the same key + value). """ # Handle if encryption is disabled. if self.aes_on == 0: @@ -599,8 +582,8 @@ def encryption_key(self, val): @property def tx_power(self): """The transmit power in dBm. Can be set to a value from -2 to 20 for high power devices - (RFM69HCW, high_power=True) or -18 to 13 for low power devices. Only integer power - levels are actually set (i.e. 12.5 will result in a value of 12 dBm). + (RFM69HCW, high_power=True) or -18 to 13 for low power devices. Only integer power + levels are actually set (i.e. 12.5 will result in a value of 12 dBm). """ # Follow table 10 truth table from the datasheet for determining power # level from the individual PA level bits and output power register. @@ -661,8 +644,8 @@ def tx_power(self, val): @property def rssi(self): """The received strength indicator (in dBm). - May be inaccuate if not read immediatey. last_rssi contains the value read immediately - receipt of the last packet. + May be inaccuate if not read immediatey. last_rssi contains the value read immediately + receipt of the last packet. """ # Read RSSI register and convert to value using formula in datasheet. return -self._read_u8(_REG_RSSI_VALUE) / 2.0 @@ -670,8 +653,8 @@ def rssi(self): @property def bitrate(self): """The modulation bitrate in bits/second (or chip rate if Manchester encoding is enabled). - Can be a value from ~489 to 32mbit/s, but see the datasheet for the exact supported - values. + Can be a value from ~489 to 32mbit/s, but see the datasheet for the exact supported + values. """ msb = self._read_u8(_REG_BITRATE_MSB) lsb = self._read_u8(_REG_BITRATE_LSB) @@ -719,17 +702,17 @@ def send( flags=None ): """Send a string of data using the transmitter. - You can only send 60 bytes at a time - (limited by chip's FIFO size and appended headers). - This appends a 4 byte header to be compatible with the RadioHead library. - The header defaults to using the initialized attributes: - (destination,node,identifier,flags) - It may be temporarily overidden via the kwargs - destination,node,identifier,flags. - Values passed via kwargs do not alter the attribute settings. - The keep_listening argument should be set to True if you want to start listening - automatically after the packet is sent. The default setting is False. - - Returns: True if success or False if the send timed out. + You can only send 60 bytes at a time + (limited by chip's FIFO size and appended headers). + This appends a 4 byte header to be compatible with the RadioHead library. + The header defaults to using the initialized attributes: + (destination,node,identifier,flags) + It may be temporarily overidden via the kwargs - destination,node,identifier,flags. + Values passed via kwargs do not alter the attribute settings. + The keep_listening argument should be set to True if you want to start listening + automatically after the packet is sent. The default setting is False. + + Returns: True if success or False if the send timed out. """ # Disable pylint warning to not use length as a check for zero. # This is a puzzling warning as the below code is clearly the most @@ -780,9 +763,9 @@ def send( def send_with_ack(self, data): """Reliable Datagram mode: - Send a packet with data and wait for an ACK response. - The packet header is automatically generated. - If enabled, the packet transmission will be retried on failure + Send a packet with data and wait for an ACK response. + The packet header is automatically generated. + If enabled, the packet transmission will be retried on failure """ if self.ack_retries: retries_remaining = self.ack_retries @@ -820,18 +803,18 @@ def receive( self, *, keep_listening=True, with_ack=False, timeout=None, with_header=False ): """Wait to receive a packet from the receiver. If a packet is found the payload bytes - are returned, otherwise None is returned (which indicates the timeout elapsed with no - reception). - If keep_listening is True (the default) the chip will immediately enter listening mode - after reception of a packet, otherwise it will fall back to idle mode and ignore any - future reception. - All packets must have a 4 byte header for compatibilty with the - RadioHead library. - The header consists of 4 bytes (To,From,ID,Flags). The default setting will strip - the header before returning the packet to the caller. - If with_header is True then the 4 byte header will be returned with the packet. - The payload then begins at packet[4]. - If with_ack is True, send an ACK after receipt (Reliable Datagram mode) + are returned, otherwise None is returned (which indicates the timeout elapsed with no + reception). + If keep_listening is True (the default) the chip will immediately enter listening mode + after reception of a packet, otherwise it will fall back to idle mode and ignore any + future reception. + All packets must have a 4 byte header for compatibilty with the + RadioHead library. + The header consists of 4 bytes (To,From,ID,Flags). The default setting will strip + the header before returning the packet to the caller. + If with_header is True then the 4 byte header will be returned with the packet. + The payload then begins at packet[4]. + If with_ack is True, send an ACK after receipt (Reliable Datagram mode) """ timed_out = False if timeout is None: diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 5e81409..ea89fb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/examples/rfm69_header.py b/examples/rfm69_header.py index 57f4f45..973fe85 100644 --- a/examples/rfm69_header.py +++ b/examples/rfm69_header.py @@ -1,5 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to display raw packets including header -# Author: Jerry Needell + # import board import busio diff --git a/examples/rfm69_node1.py b/examples/rfm69_node1.py index 6420aeb..e956c25 100644 --- a/examples/rfm69_node1.py +++ b/examples/rfm69_node1.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to send a packet periodically between addressed nodes -# Author: Jerry Needell -# + import time import board import busio diff --git a/examples/rfm69_node1_ack.py b/examples/rfm69_node1_ack.py index 621affc..f5c6b3a 100644 --- a/examples/rfm69_node1_ack.py +++ b/examples/rfm69_node1_ack.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to send a packet periodically between addressed nodes with ACK -# Author: Jerry Needell -# + import time import board import busio diff --git a/examples/rfm69_node1_bonnet.py b/examples/rfm69_node1_bonnet.py index 2de9324..dbc3770 100644 --- a/examples/rfm69_node1_bonnet.py +++ b/examples/rfm69_node1_bonnet.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to send a packet periodically between addressed nodes -# Author: Jerry Needell -# + import board import busio import digitalio diff --git a/examples/rfm69_node2.py b/examples/rfm69_node2.py index 2eed5e9..9d506eb 100644 --- a/examples/rfm69_node2.py +++ b/examples/rfm69_node2.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to send a packet periodically between addressed nodes -# Author: Jerry Needell -# + import time import board import busio diff --git a/examples/rfm69_node2_ack.py b/examples/rfm69_node2_ack.py index 9ba7ca5..4a72d3a 100644 --- a/examples/rfm69_node2_ack.py +++ b/examples/rfm69_node2_ack.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to receive addressed packed with ACK and send a response -# Author: Jerry Needell -# + import time import board import busio diff --git a/examples/rfm69_rpi_interrupt.py b/examples/rfm69_rpi_interrupt.py index 2dc02aa..7cf9344 100644 --- a/examples/rfm69_rpi_interrupt.py +++ b/examples/rfm69_rpi_interrupt.py @@ -1,8 +1,10 @@ +# SPDX-FileCopyrightText: 2020 Tony DiCola, Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example using Interrupts to send a message and then wait indefinitely for messages # to be received. Interrupts are used only for receive. sending is done with polling. # This example is for systems that support interrupts like the Raspberry Pi with "blinka" # CircuitPython does not support interrupts so it will not work on Circutpython boards -# Author: Tony DiCola, Jerry Needell import time import board import busio diff --git a/examples/rfm69_rpi_simpletest.py b/examples/rfm69_rpi_simpletest.py index 5de4fe9..333afb2 100644 --- a/examples/rfm69_rpi_simpletest.py +++ b/examples/rfm69_rpi_simpletest.py @@ -1,7 +1,10 @@ +# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries +# SPDX-License-Identifier: MIT + # Simple example to send a message and then wait indefinitely for messages # to be received. This uses the default RadioHead compatible GFSK_Rb250_Fd250 # modulation and packet format for the radio. -# Author: Tony DiCola + import board import busio import digitalio diff --git a/examples/rfm69_simpletest.py b/examples/rfm69_simpletest.py index bf93cef..d160090 100644 --- a/examples/rfm69_simpletest.py +++ b/examples/rfm69_simpletest.py @@ -1,7 +1,9 @@ +# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries +# SPDX-License-Identifier: MIT + # Simple example to send a message and then wait indefinitely for messages # to be received. This uses the default RadioHead compatible GFSK_Rb250_Fd250 # modulation and packet format for the radio. -# Author: Tony DiCola import board import busio import digitalio diff --git a/examples/rfm69_transmit.py b/examples/rfm69_transmit.py index 39c9832..1431b22 100644 --- a/examples/rfm69_transmit.py +++ b/examples/rfm69_transmit.py @@ -1,6 +1,8 @@ +# SPDX-FileCopyrightText: 2020 Jerry Needell for Adafruit Industries +# SPDX-License-Identifier: MIT + # Example to send a packet periodically -# Author: Jerry Needell -# + import time import board import busio diff --git a/requirements.txt b/requirements.txt index 3031961..f675e3b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py index 7eadc3f..064d444 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: