├── .gitignore ├── LICENSE.md ├── NEWS.rst ├── README.rst ├── asgimqtt ├── __init__.py ├── cli.py └── server.py ├── examples └── example_project │ ├── README.rst │ ├── example_project │ ├── __init__.py │ ├── asgi.py │ ├── routing.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py │ ├── manage.py │ ├── print_ws │ ├── __init__.py │ ├── admin.py │ ├── apps.py │ ├── consumers.py │ ├── migrations │ │ └── __init__.py │ ├── models.py │ ├── templates │ │ └── print_ws │ │ │ └── index.html │ ├── tests.py │ └── views.py │ └── requirements.txt └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | /*.egg-info 3 | /.eggs 4 | /build 5 | /dist 6 | __pycache__ 7 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /NEWS.rst: -------------------------------------------------------------------------------- 1 | NEWS 2 | ==== 3 | 4 | 0.2.0 5 | ----- 6 | 7 | * Broker authentication (thanks to mussha ) 8 | * ``paho-mqtt 1.3`` support (thanks to mussha ) 9 | * Example project 10 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | asgimqtt 2 | ======== 3 | 4 | ``asgimqtt`` is a simple `MQTT `_ interface for `ASGI 5 | `_. 6 | 7 | Installation 8 | ------------ 9 | 10 | Install with ``pip``:: 11 | 12 | pip install asgimqtt 13 | 14 | 15 | Usage 16 | ----- 17 | 18 | Connect the server to a running `MQTT` broker:: 19 | 20 | asgimqtt --host localhost --port 1883 django_project.asgi:channel_layer 21 | 22 | 23 | In your Django code:: 24 | 25 | # routing.py 26 | channels_routing = [ 27 | route("mqtt.sub", mqtt_consumer), 28 | ] 29 | 30 | **Note**: you can only receive messages published in ``MQTT`` broker (channel 31 | ``mqtt.sub``). 32 | 33 | The keys are: 34 | 35 | * ``host``: host of the ``MQTT`` broker 36 | * ``port``: port of the ``MQTT`` broker 37 | * ``topic``: topic of the ``MQTT`` message 38 | * ``payload``: payload of the ``MQTT`` message 39 | * ``qos``: quality of service of the ``MQTT`` message (0, 1 or 2) 40 | -------------------------------------------------------------------------------- /asgimqtt/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.2.0" 2 | -------------------------------------------------------------------------------- /asgimqtt/cli.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import importlib 3 | import argparse 4 | import logging 5 | 6 | from .server import Server 7 | 8 | 9 | logger = logging.getLogger(__name__) 10 | 11 | 12 | def channel_type(channel_name): 13 | sys.path.insert(0, ".") 14 | module_path, object_path = channel_name.split(":", 1) 15 | channel_layer = importlib.import_module(module_path) 16 | for bit in object_path.split("."): 17 | channel_layer = getattr(channel_layer, bit) 18 | 19 | return channel_layer 20 | 21 | 22 | def main(): 23 | parser = argparse.ArgumentParser(description="Simple MQTT bridge for ASGI") 24 | parser.add_argument("-H", "--host", help="MQTT broker host", 25 | default="localhost") 26 | parser.add_argument("-p", "--port", help="MQTT broker port", type=int, 27 | default=1883) 28 | parser.add_argument("-v", "--verbosity", action="count", default=0, 29 | help="Set verbosity") 30 | parser.add_argument("channel_layer", 31 | help=("The ASGI channel layer instance to use as " 32 | "path.to.module:instance.path")) 33 | parser.add_argument("-U", "--username", help="MQTT username to authorised connection") 34 | parser.add_argument("-P", "--password", help="MQTT password to authorised connection") 35 | 36 | args = parser.parse_args() 37 | logging.basicConfig( 38 | level={ 39 | 0: logging.WARN, 40 | 1: logging.INFO, 41 | }.get(args.verbosity, logging.DEBUG), 42 | format="%(asctime)-15s %(levelname)-8s %(message)s", 43 | ) 44 | channel_layer = channel_type(args.channel_layer) 45 | logger.info("Starting interface to MQTT broker {}:{}, channel {}".format( 46 | args.host, args.port, args.channel_layer 47 | )) 48 | server = Server(channel_layer, args.host, args.port, args.username, args.password) 49 | server.run() 50 | -------------------------------------------------------------------------------- /asgimqtt/server.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import time 3 | import signal 4 | 5 | import paho.mqtt.client as mqtt 6 | 7 | logger = logging.getLogger(__name__) 8 | 9 | 10 | def on_connect(client, userdata, flags, rc): 11 | logger.info("Connected with status {}".format(rc)) 12 | client.subscribe("#", 2) 13 | 14 | 15 | def on_disconnect(client, userdata, rc): 16 | server = userdata["server"] 17 | logger.info("Disconnected") 18 | if not server.stop: 19 | j = 3 20 | for i in range(j): 21 | logger.info("Trying to reconnect") 22 | try: 23 | client.reconnect() 24 | logger.info("Reconnected") 25 | break 26 | except Exception as e: 27 | if i < j: 28 | logger.warn(e) 29 | time.sleep(1) 30 | continue 31 | else: 32 | raise 33 | 34 | 35 | def on_message(client, userdata, message): 36 | logger.debug("Received message from topic {}".format(message.topic)) 37 | channel = userdata["channel"] 38 | msg = { 39 | "topic": message.topic, 40 | "payload": message.payload, 41 | "qos": message.qos, 42 | "host": userdata["host"], 43 | "port": userdata["port"], 44 | } 45 | try: 46 | channel.send("mqtt.sub", msg) 47 | except Exception as e: 48 | logger.error("Cannot send message {}".format(msg)) 49 | logger.exception(e) 50 | 51 | 52 | class Server(object): 53 | def __init__(self, channel, host, port, username=None, password=None): 54 | self.channel = channel 55 | self.host = host 56 | self.port = port 57 | self.client = mqtt.Client(userdata={ 58 | "server": self, 59 | "channel": self.channel, 60 | "host": self.host, 61 | "port": self.port, 62 | }) 63 | self.username = username 64 | self.password = password 65 | self.client.on_connect = on_connect 66 | self.client.on_disconnect = on_disconnect 67 | self.client.on_message = on_message 68 | 69 | def stop_server(self, signum, frame): 70 | logger.info("Received signal {}, terminating".format(signum)) 71 | self.stop = True 72 | 73 | def set_signal_handlers(self): 74 | signal.signal(signal.SIGTERM, self.stop_server) 75 | signal.signal(signal.SIGINT, self.stop_server) 76 | 77 | def run(self): 78 | self.stop = False 79 | self.set_signal_handlers() 80 | if self.username: 81 | self.client.username_pw_set(username=self.username, password=self.password) 82 | self.client.connect(self.host, self.port) 83 | logger.info("Starting loop") 84 | while not self.stop: 85 | logger.debug("Restarting loop") 86 | self.client.loop() 87 | 88 | self.client.disconnect() 89 | -------------------------------------------------------------------------------- /examples/example_project/README.rst: -------------------------------------------------------------------------------- 1 | Example project 2 | =============== 3 | 4 | * Install dependencies: ``pip install -r requirements.txt`` 5 | * Start ``redis`` 6 | * Start MQTT broker (e.g. ``mosquitto``) 7 | * Migrate models ``./manage.py migrate`` 8 | * Run ``asgimqtt`` 9 | * Run webserver ``./manage.py runserver`` 10 | * Open http://localhost:8000 11 | * Publish some messages to MQTT (``mosquitto_pub -t TOPIC -m MESSAGE``) 12 | * The messages are sent through WebSocket to http://localhost:8000 13 | -------------------------------------------------------------------------------- /examples/example_project/example_project/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edigiacomo/asgi-mqtt/ba4f7312d8eeac48f80349a324883d133742079e/examples/example_project/example_project/__init__.py -------------------------------------------------------------------------------- /examples/example_project/example_project/asgi.py: -------------------------------------------------------------------------------- 1 | import os 2 | from channels.asgi import get_channel_layer 3 | 4 | 5 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings") 6 | 7 | channel_layer = get_channel_layer() 8 | -------------------------------------------------------------------------------- /examples/example_project/example_project/routing.py: -------------------------------------------------------------------------------- 1 | from channels.routing import route 2 | from print_ws.consumers import on_ws_connect, on_ws_disconnect, on_mqtt_message 3 | 4 | 5 | channel_routing = [ 6 | route("websocket.connect", on_ws_connect), 7 | route("websocket.disconnect", on_ws_disconnect), 8 | route("mqtt.sub", on_mqtt_message), 9 | ] 10 | -------------------------------------------------------------------------------- /examples/example_project/example_project/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for example_project project. 3 | 4 | Generated by 'django-admin startproject' using Django 1.9.12. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.9/topics/settings/ 8 | 9 | For the full list of settings and their values, see 10 | https://docs.djangoproject.com/en/1.9/ref/settings/ 11 | """ 12 | 13 | import os 14 | 15 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 16 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 17 | 18 | 19 | # Quick-start development settings - unsuitable for production 20 | # See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/ 21 | 22 | # SECURITY WARNING: keep the secret key used in production secret! 23 | SECRET_KEY = '#r)rcod*%4r&3#sc$kc#6%938@_d6+(8_os4d3(9pz2&n_krg3' 24 | 25 | # SECURITY WARNING: don't run with debug turned on in production! 26 | DEBUG = True 27 | 28 | ALLOWED_HOSTS = [] 29 | 30 | 31 | # Application definition 32 | 33 | INSTALLED_APPS = [ 34 | 'django.contrib.admin', 35 | 'django.contrib.auth', 36 | 'django.contrib.contenttypes', 37 | 'django.contrib.sessions', 38 | 'django.contrib.messages', 39 | 'django.contrib.staticfiles', 40 | 'channels', 41 | 'print_ws', 42 | ] 43 | 44 | MIDDLEWARE_CLASSES = [ 45 | 'django.middleware.security.SecurityMiddleware', 46 | 'django.contrib.sessions.middleware.SessionMiddleware', 47 | 'django.middleware.common.CommonMiddleware', 48 | 'django.middleware.csrf.CsrfViewMiddleware', 49 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 50 | 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 51 | 'django.contrib.messages.middleware.MessageMiddleware', 52 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 53 | ] 54 | 55 | ROOT_URLCONF = 'example_project.urls' 56 | 57 | TEMPLATES = [ 58 | { 59 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 60 | 'DIRS': [], 61 | 'APP_DIRS': True, 62 | 'OPTIONS': { 63 | 'context_processors': [ 64 | 'django.template.context_processors.debug', 65 | 'django.template.context_processors.request', 66 | 'django.contrib.auth.context_processors.auth', 67 | 'django.contrib.messages.context_processors.messages', 68 | ], 69 | }, 70 | }, 71 | ] 72 | 73 | WSGI_APPLICATION = 'example_project.wsgi.application' 74 | 75 | 76 | # Database 77 | # https://docs.djangoproject.com/en/1.9/ref/settings/#databases 78 | 79 | DATABASES = { 80 | 'default': { 81 | 'ENGINE': 'django.db.backends.sqlite3', 82 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 83 | } 84 | } 85 | 86 | 87 | # Password validation 88 | # https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators 89 | 90 | AUTH_PASSWORD_VALIDATORS = [ 91 | { 92 | 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', 93 | }, 94 | { 95 | 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', 96 | }, 97 | { 98 | 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', 99 | }, 100 | { 101 | 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', 102 | }, 103 | ] 104 | 105 | 106 | # Internationalization 107 | # https://docs.djangoproject.com/en/1.9/topics/i18n/ 108 | 109 | LANGUAGE_CODE = 'en-us' 110 | 111 | TIME_ZONE = 'UTC' 112 | 113 | USE_I18N = True 114 | 115 | USE_L10N = True 116 | 117 | USE_TZ = True 118 | 119 | 120 | # Static files (CSS, JavaScript, Images) 121 | # https://docs.djangoproject.com/en/1.9/howto/static-files/ 122 | 123 | STATIC_URL = '/static/' 124 | 125 | CHANNEL_LAYERS = { 126 | "default": { 127 | "BACKEND": "asgi_redis.RedisChannelLayer", 128 | "CONFIG": { 129 | "hosts": [("localhost", 6379)], 130 | }, 131 | "ROUTING": "example_project.routing.channel_routing", 132 | }, 133 | } 134 | -------------------------------------------------------------------------------- /examples/example_project/example_project/urls.py: -------------------------------------------------------------------------------- 1 | """example_project URL Configuration 2 | 3 | The `urlpatterns` list routes URLs to views. For more information please see: 4 | https://docs.djangoproject.com/en/1.9/topics/http/urls/ 5 | Examples: 6 | Function views 7 | 1. Add an import: from my_app import views 8 | 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') 9 | Class-based views 10 | 1. Add an import: from other_app.views import Home 11 | 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') 12 | Including another URLconf 13 | 1. Import the include() function: from django.conf.urls import url, include 14 | 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) 15 | """ 16 | from django.conf.urls import url 17 | from django.contrib import admin 18 | from print_ws import views 19 | 20 | urlpatterns = [ 21 | url(r'^admin/', admin.site.urls), 22 | url(r'^$', views.index), 23 | ] 24 | -------------------------------------------------------------------------------- /examples/example_project/example_project/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for example_project project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings") 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /examples/example_project/manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings") 7 | 8 | from django.core.management import execute_from_command_line 9 | 10 | execute_from_command_line(sys.argv) 11 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edigiacomo/asgi-mqtt/ba4f7312d8eeac48f80349a324883d133742079e/examples/example_project/print_ws/__init__.py -------------------------------------------------------------------------------- /examples/example_project/print_ws/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class PrintWsConfig(AppConfig): 5 | name = 'print_ws' 6 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/consumers.py: -------------------------------------------------------------------------------- 1 | import json 2 | 3 | from channels import Group 4 | 5 | 6 | def on_ws_connect(message): 7 | message.reply_channel.send({"accept": True}) 8 | Group("mqtt").add(message.reply_channel) 9 | 10 | 11 | def on_ws_disconnect(message): 12 | Group("mqtt").discard(message.reply_channel) 13 | 14 | 15 | def on_mqtt_message(message): 16 | msg = "{}: {}".format(message.content["topic"], 17 | message.content["payload"].decode("utf-8")) 18 | Group("mqtt").send({ 19 | "text": msg 20 | }) 21 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edigiacomo/asgi-mqtt/ba4f7312d8eeac48f80349a324883d133742079e/examples/example_project/print_ws/migrations/__init__.py -------------------------------------------------------------------------------- /examples/example_project/print_ws/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/templates/print_ws/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /examples/example_project/print_ws/views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import render 2 | 3 | 4 | def index(request): 5 | return render(request, 'print_ws/index.html') 6 | -------------------------------------------------------------------------------- /examples/example_project/requirements.txt: -------------------------------------------------------------------------------- 1 | channels 2 | asgi-redis 3 | asgimqtt 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os.path 2 | import re 3 | from setuptools import setup 4 | 5 | 6 | def get_version(package): 7 | init_py = open(os.path.join(package, '__init__.py')).read() 8 | return re.search("^__version__ = ['\"]([^'\"]+)['\"]", init_py).group(1) 9 | 10 | 11 | setup( 12 | name="asgimqtt", 13 | version=get_version("asgimqtt"), 14 | author="Emanuele Di Giacomo", 15 | author_email="emanuele@digiacomo.cc", 16 | url="https://github.com/edigiacomo/asgi-mqtt", 17 | description="Interface between MQTT broker and ASGI", 18 | long_description=open("README.rst").read(), 19 | license="GPLv2+", 20 | packages=["asgimqtt"], 21 | install_requires=[ 22 | "paho-mqtt", 23 | ], 24 | entry_points={ 25 | "console_scripts": [ 26 | "asgimqtt=asgimqtt.cli:main", 27 | ] 28 | }, 29 | classifiers=[ 30 | 'Development Status :: 4 - Beta', 31 | 'Environment :: Web Environment', 32 | 'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)', 33 | 'Framework :: Django', 34 | 'Operating System :: OS Independent', 35 | 'Programming Language :: Python', 36 | 'Programming Language :: Python :: 2', 37 | 'Programming Language :: Python :: 2.7', 38 | 'Programming Language :: Python :: 3', 39 | 'Programming Language :: Python :: 3.4', 40 | 'Programming Language :: Python :: 3.5', 41 | 'Programming Language :: Python :: 3.6', 42 | 'Topic :: Internet :: WWW/HTTP', 43 | ] 44 | ) 45 | --------------------------------------------------------------------------------