Basic Project Structure

Author: timwedde

.gitignore

@@ -1,3 +1,6 @@
+# SublimeText stuff
+*.sublime-workspace
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -0,0 +1,34 @@
+Antificial
+======
+**Antificial** is a real-time swarm simulation framework with real-time user interaction.
+
+#### Screenshot
+![Description](https://github.com/Antificial/antificial/blob/master/title.png "Description")
+
+## Download
+* [Version 0.1](https://github.com/Antificial/antificial/archive/master.zip)
+
+## Usage
+```
+$ git clone https://github.com/Antificial/antificial.git
+$ cd antificial/
+$ python main.py
+```
+
+## Contributors
+
+### Contributors on GitHub
+* [Contributors](https://github.com/Antificial/antificial/graphs/contributors)
+
+### Third party libraries
+* [Kivy](https://kivy.org) Graphics Framework
+* [OpenCV](http://opencv.org) Computer Vision Library
+
+## License
+* see [LICENSE](https://github.com/Antificial/antificial/blob/master/LICENSE) file
+
+## Version
+* Version 0.1
+
+## How to use this code
+* see [USAGE](https://github.com/Antificial/antificial/blob/master/USAGE.md) file

USAGE.md

@@ -0,0 +1,3 @@
+Usage
+======
+TODO

antificial.sublime-project

@@ -0,0 +1,28 @@
+{
+    "build_systems": [{
+        "name": "Python",
+        "shell_cmd": "python $project_path/antificial/main.py"
+    }],
+    "folders": [{
+        "file_exclude_patterns": [
+            "*.pyc"
+        ],
+        "folder_exclude_patterns": [
+            "__pycache__"
+        ],
+        "name": "Source",
+        "path": "antificial"
+    }, {
+        "file_exclude_patterns": [
+            "antificial.sublime-project"
+        ],
+        "folder_exclude_patterns": [
+            "antificial"
+        ],
+        "name": "Root",
+        "path": "."
+    }],
+    "settings": {
+        "tab_size": 4
+    }
+}

antificial/framework/__init__.py

@@ -0,0 +1,12 @@
+#! /usr/bin/env python
+
+# Import all modules to be directly available when this module is loaded
+from .handler import run
+from .colony import *
+
+# Use this to set us up if called directly
+def main():
+    print("This is the FW module reporting...")
+
+if __name__ == '__main__':
+    main()

antificial/framework/colony/Ant.py

@@ -0,0 +1,5 @@
+class Ant(object):
+    """Ant documentation"""
+    def __init__(self, arg):
+        super(Ant, self).__init__()
+        self.arg = arg

antificial/framework/colony/__init__.py

@@ -0,0 +1,10 @@
+#! /usr/bin/env python
+
+from framework.colony.Ant import *
+
+# Use this to set us up if called directly
+def main():
+    print("This is the Colony module reporting...")
+
+if __name__ == '__main__':
+    main()

antificial/framework/handler.py

@@ -0,0 +1,38 @@
+#! /usr/bin/env python
+
+import util
+import framework.colony as colony
+import time
+
+RUNNING = True
+TIMEOUT = 1
+
+def shutdown():
+    print("[FW] Shutting down...")
+
+def handle_commands(cc_queue):
+    try:
+        cc = cc_queue.get(False)
+        if cc == "done":
+            util.iprint("[IR] Quit")
+            global RUNNING
+            RUNNING = False
+    except:
+        pass
+
+def work(cc_queue, ir_output, fw_input):
+    while RUNNING:
+        handle_commands(cc_queue)
+        if ir_output.poll(TIMEOUT):
+            input = ir_output.recv()
+            util.iprint("[FW] Received {input}!")
+            util.iprint("[FW] Sending {input} to RR...")
+            fw_input.send(input)
+
+# Run this from other code
+def run(cc_queue, ir_output, fw_input):
+    try:
+        print("Running FW module...")
+        work(cc_queue, ir_output, fw_input)
+    except KeyboardInterrupt as e:
+        shutdown()

antificial/image_recognition/__init__.py

@@ -0,0 +1,11 @@
+#! /usr/bin/env python
+
+from .handler import run
+
+# Use this to set us up if called directly
+def main():
+    print("This is the IR module reporting...")
+    run()
+
+if __name__ == '__main__':
+    main()

antificial/image_recognition/handler.py

@@ -0,0 +1,36 @@
+#! /usr/bin/env python
+
+import util
+import time
+
+RUNNING = True
+
+def shutdown():
+    print("[IR] Shutting down...")
+
+def handle_commands(cc_queue):
+    try:
+        cc = cc_queue.get(False)
+        if cc == "done":
+            util.iprint("[IR] Quit")
+            global RUNNING
+            RUNNING = False
+    except:
+        pass
+
+def work(cc_queue, ir_input):
+    count = 0
+    while RUNNING:
+        handle_commands(cc_queue)
+        util.iprint("[IR] Sending number {count} to FW...")
+        ir_input.send(count)
+        count += 1
+        time.sleep(1.0)
+
+# Run this from other code
+def run(cc_queue, ir_input):
+    try:
+        print("Running IR module...")
+        work(cc_queue, ir_input)
+    except KeyboardInterrupt as e:
+        shutdown()