civicstream 1.0.0__tar.gz

civicstream-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VU-Civic
+
+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.

civicstream-1.0.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: civicstream
+Version: 1.0.0
+Summary: CivicAlert Streaming Data Capture and Visualization Tool
+Home-page: https://github.com/vu-civic/tools
+Author: Will Hedgecock
+Author-email: ronald.w.hedgecock@vanderbilt.edu
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pyserial
+Requires-Dist: pygame
+Requires-Dist: PyOpenGL
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+CivicStream
+===========
+
+This package provides a command-line tool for capturing and visualizing streaming data
+from a CivicAlert sensor device. It can be accessed from a command terminal by entering:
+
+``civicstream``
+
+Enter ``civicstream -h`` to see a listing of available command line parameters, including
+activation of an IMU visualizer or configuration of the number of incoming audio channels.

civicstream-1.0.0/README.rst

@@ -0,0 +1,10 @@
+CivicStream
+===========
+
+This package provides a command-line tool for capturing and visualizing streaming data
+from a CivicAlert sensor device. It can be accessed from a command terminal by entering:
+
+``civicstream``
+
+Enter ``civicstream -h`` to see a listing of available command line parameters, including
+activation of an IMU visualizer or configuration of the number of incoming audio channels.

civicstream-1.0.0/app/civicstream.py

@@ -0,0 +1,280 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Required libraries and imports
+from OpenGL.GL import *
+from OpenGL.GLU import gluPerspective
+from datetime import datetime
+import itertools, math, struct, wave
+import serial.tools.list_ports
+import numpy as np
+import argparse
+
+# Hide the Pygame support prompt
+import os
+os.environ['PYGAME_HIDE_SUPPORT_PROMPT'] = 'True'
+import pygame, pygame.locals
+
+# Device constants
+DEVICE_VID = 4617
+DEVICE_PID = 2829
+PACKET_HEADER_BYTES = 36
+AUDIO_SAMPLE_WIDTH = 2
+AUDIO_SAMPLE_RATE = 96000
+AUDIO_BUFFER_SAMPLES = 32000
+AUDIO_NUM_BYTES_PER_CHANNEL = AUDIO_SAMPLE_RATE * AUDIO_SAMPLE_WIDTH
+AUDIO_BUFFER_CHUNKS = 4 * AUDIO_SAMPLE_RATE // AUDIO_BUFFER_SAMPLES
+PACKET_END_DELIMITER = b"\xFE\xF0\xF2\x25"
+RESPONSE_PACKET_DELIMITER = b"\xFE\xF9"
+RESPONSE_ACK_PACKET = b"\x01\x02"
+
+# Data packet structure
+class DataPacket:
+  def __init__(self, audio, num_channels, timestamp, lat, lon, ht, q1, q2, q3, delimiter):
+    self.audio_num_bytes = num_channels * AUDIO_NUM_BYTES_PER_CHANNEL
+    self.audio = np.concatenate(np.frombuffer(audio, dtype=np.int16).reshape(AUDIO_BUFFER_CHUNKS, num_channels, -1), axis=1).tobytes()
+    self.timestamp = timestamp
+    self.lat = lat
+    self.lon = lon
+    self.ht = ht
+    self.qx = q2 / 1073741824.0
+    self.qy = q3 / 1073741824.0
+    self.qz = -q1 / 1073741824.0
+    self.qw = (1.0 - (self.qx**2 + self.qy**2 + self.qz**2))**0.5
+    self.roll, self.pitch, self.yaw = self.__quat_to_roll_pitch_yaw__()
+    self.delimiter = delimiter
+
+  @staticmethod
+  def _quat_mult(q1w, q1x, q1y, q1z, q2w, q2x, q2y, q2z):
+    return (q1w * q2w - q1x * q2x - q1y * q2y - q1z * q2z,
+            q1w * q2x + q1x * q2w + q1y * q2z - q1z * q2y,
+            q1w * q2y - q1x * q2z + q1y * q2w + q1z * q2x,
+            q1w * q2z + q1x * q2y - q1y * q2x + q1z * q2w)
+  
+  @staticmethod
+  def _heading_to_direction(degrees):
+    if degrees > 330.0 or degrees <= 30.0:
+      return "N"
+    elif 30.0 < degrees <= 60.0:
+      return "NE"
+    elif 60.0 < degrees <= 120.0:
+      return "E"
+    elif 120.0 < degrees <= 150.0:
+      return "SE"
+    elif 150.0 < degrees <= 210.0:
+      return "S"
+    elif 210.0 < degrees <= 240.0:
+      return "SW"
+    elif 240.0 < degrees <= 300.0:
+      return "W"
+    elif 300.0 < degrees <= 330.0:
+      return "NW"
+
+  def __quat_to_roll_pitch_yaw__(self):
+    # If the quaternion is invalid, return zero angles
+    if isinstance(self.qw, complex):
+      return 0, 0, 0
+
+    # Compute roll (x-axis rotation)
+    t0 = self.qw * self.qx + self.qy * self.qz
+    t1 = 0.5 - (self.qx * self.qx + self.qy * self.qy)
+    roll = math.atan2(t0, t1) * 180.0 / math.pi
+
+    # Compute pitch (y-axis rotation)
+    t2 = 2.0 * (self.qw * self.qy - self.qx * self.qz)
+    t2 = max(-1.0, min(1.0, t2))
+    pitch = math.asin(t2) * 180.0 / math.pi
+
+    # Compute yaw (z-axis rotation)
+    t3 = self.qw * self.qz + self.qx * self.qy
+    t4 = 0.5 - (self.qy * self.qy + self.qz * self.qz)
+    yaw = math.atan2(t3, t4) * 180.0 / math.pi
+    #return roll, yaw, pitch
+    return -(90.0 + roll), pitch, (yaw - 90.0) % 360.0
+
+  def to_bytes(self):
+    return struct.pack(f"<{self.audio_num_bytes}sdfffiii4s", self.audio, self.timestamp, self.lat, self.lon, self.ht, self.q1, self.q2, self.q3, self.delimiter)
+
+  def __str__(self):
+    time_string = datetime.fromtimestamp(self.timestamp).strftime("%Y-%m-%d %H:%M:%S")
+    return f"\n------------------------- {time_string} -------------------------\n" \
+           f"Audio: {len(self.audio)} samples\n" \
+           f"Timestamp: {self.timestamp}\n" \
+           f"Location: <{self.lat}, {self.lon}, {self.ht}>\n" \
+           f"Orientation (Quaternions): <{self.qw}, {self.qx}, {self.qy}, {self.qz}>\n" \
+           f"Orientation (Roll/Pitch/Yaw): <{self.roll}, {self.pitch}, {self.yaw}>\n"
+
+  def __repr__(self):
+    return self.__str__()
+
+  @staticmethod
+  def from_bytes(data, num_channels):
+    audio_num_bytes = num_channels * AUDIO_NUM_BYTES_PER_CHANNEL
+    unpacked_data = struct.unpack("<dfffiii4s", data[audio_num_bytes:])
+    return DataPacket(data[:audio_num_bytes], num_channels, *unpacked_data)
+
+
+# Visualizer class to handle IMU graphics rendering
+class ImuVisualizer:
+  def __init__(self):
+      print("Initializing graphics libraries...")
+      pygame.init()
+      pygame.display.set_mode((640, 480), pygame.locals.OPENGL | pygame.locals.DOUBLEBUF)
+      pygame.display.set_caption("CivicAlert Orientation Visualizer")
+      glViewport(0, 0, 640, 480)
+      glMatrixMode(GL_PROJECTION)
+      glLoadIdentity()
+      gluPerspective(45, 1.0*640/480, 0.1, 100.0)
+      glMatrixMode(GL_MODELVIEW)
+      glLoadIdentity()
+      glShadeModel(GL_SMOOTH)
+      glClearColor(0.0, 0.0, 0.0, 0.0)
+      glClearDepth(1.0)
+      glEnable(GL_DEPTH_TEST)
+      glDepthFunc(GL_LEQUAL)
+      glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST)
+
+  def __draw_text__(self, position, textString, size):
+    font = pygame.font.SysFont("Courier", size, True)
+    textSurface = font.render(textString, True, (255, 255, 255, 255), (0, 0, 0, 255))
+    textData = pygame.image.tostring(textSurface, "RGBA", True)
+    glRasterPos3d(*position)
+    glDrawPixels(textSurface.get_width(), textSurface.get_height(), GL_RGBA, GL_UNSIGNED_BYTE, textData)
+
+  def update(self, yaw, pitch, roll, qw, qx, qy, qz):
+    pygame.event.poll()
+    glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
+    glLoadIdentity()
+    glTranslatef(0, 0.0, -7.0)
+    self.__draw_text__((-2.6, 1.8, 2), "CivicAlert Orientation", 18)
+    self.__draw_text__((-2.6, 1.6, 2), f"Heading: {int(yaw)}\N{DEGREE SIGN} ({DataPacket._heading_to_direction(yaw)}), Tilt: {int(pitch)}\N{DEGREE SIGN}", 16)
+    self.__draw_text__((-2.6, -1.9, 2), f"Yaw: {yaw:.2f}, Pitch: {pitch:.2f}, Roll: {roll:.2f}", 16)
+    glRotatef(2 * math.acos(qw) * 180.00 / math.pi, qz, qy, qx)
+
+    glBegin(GL_QUADS)
+    glColor3f(0.0, 1.0, 0.0)
+    glVertex3f(1.0, 0.2, -1.0)
+    glVertex3f(-1.0, 0.2, -1.0)
+    glVertex3f(-1.0, 0.2, 1.0)
+    glVertex3f(1.0, 0.2, 1.0)
+
+    glColor3f(1.0, 0.5, 0.0)
+    glVertex3f(1.0, -0.2, 1.0)
+    glVertex3f(-1.0, -0.2, 1.0)
+    glVertex3f(-1.0, -0.2, -1.0)
+    glVertex3f(1.0, -0.2, -1.0)
+
+    glColor3f(1.0, 0.0, 0.0)
+    glVertex3f(1.0, 0.2, 1.0)
+    glVertex3f(-1.0, 0.2, 1.0)
+    glVertex3f(-1.0, -0.2, 1.0)
+    glVertex3f(1.0, -0.2, 1.0)
+
+    glColor3f(1.0, 1.0, 0.0)
+    glVertex3f(1.0, -0.2, -1.0)
+    glVertex3f(-1.0, -0.2, -1.0)
+    glVertex3f(-1.0, 0.2, -1.0)
+    glVertex3f(1.0, 0.2, -1.0)
+
+    glColor3f(0.0, 0.0, 1.0)
+    glVertex3f(-1.0, 0.2, 1.0)
+    glVertex3f(-1.0, 0.2, -1.0)
+    glVertex3f(-1.0, -0.2, -1.0)
+    glVertex3f(-1.0, -0.2, 1.0)
+
+    glColor3f(1.0, 0.0, 1.0)
+    glVertex3f(1.0, 0.2, -1.0)
+    glVertex3f(1.0, 0.2, 1.0)
+    glVertex3f(1.0, -0.2, 1.0)
+    glVertex3f(1.0, -0.2, -1.0)
+    glEnd()
+    pygame.display.flip()
+
+
+# Helper function to interleave non-interleaved audio data
+def interleave_audio(audio_data, num_channels):
+  audio_num_bytes = num_channels * AUDIO_NUM_BYTES_PER_CHANNEL
+  ch_data = [np.frombuffer(audio_data[i:i+AUDIO_NUM_BYTES_PER_CHANNEL], dtype=np.int16)
+            for i in range(0, audio_num_bytes, AUDIO_NUM_BYTES_PER_CHANNEL)]
+  return np.array(list(itertools.chain(*zip(*ch_data)))).tobytes()
+
+
+# Main program loop
+def main_loop(visualize_imu, num_channels):
+
+  # Search for a CivicAlert device
+  device = None
+  for port in serial.tools.list_ports.comports():
+    if port.vid == DEVICE_VID and port.pid == DEVICE_PID:
+      print(f"CivicAlert device found on {port.device}")
+      device = port.device
+      break
+  if device is None:
+    print("CivicAlert device not found")
+    exit(1)
+
+  # Initialize the IMU visualizer if requested
+  imu_visualizer = ImuVisualizer() if visualize_imu else None
+
+  # Initiate a connection to the device
+  try:
+    print("Connecting to the CivicAlert device...")
+    with serial.Serial(device) as ser:
+      print("Successfully connected to the device!")
+      packet_size_bytes = PACKET_HEADER_BYTES + (num_channels * AUDIO_NUM_BYTES_PER_CHANNEL)
+
+      # Create a new wave file to save the audio data
+      now = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+      with wave.open(f"civicalert-{now}.wav", "wb") as wav_file:
+        wav_file.setnchannels(num_channels)
+        wav_file.setsampwidth(AUDIO_SAMPLE_WIDTH)
+        wav_file.setframerate(AUDIO_SAMPLE_RATE)
+
+        # Search for consecutive packet-ending delimiters
+        print("Awaiting packet synchronization...")
+        while True:
+          data = ser.read(2 * packet_size_bytes)
+          idx = data.find(PACKET_END_DELIMITER)
+          if idx > -1:
+            data = ser.read(idx + len(PACKET_END_DELIMITER))
+            if data[-len(PACKET_END_DELIMITER):] == PACKET_END_DELIMITER:
+              break
+        print("Packet synchronization complete! Starting data capture...")
+
+        # Loop forever reading data from the device
+        while True:
+
+          # Read the packet data
+          data = ser.read(packet_size_bytes)
+          ser.write(RESPONSE_PACKET_DELIMITER + RESPONSE_ACK_PACKET)
+
+          # Append the received audio to the WAV file and print the packet
+          packet = DataPacket.from_bytes(data, num_channels)
+          if packet.delimiter != PACKET_END_DELIMITER:
+            break
+          wav_file.writeframes(interleave_audio(packet.audio, num_channels))
+          if imu_visualizer:
+            imu_visualizer.update(packet.yaw, packet.pitch, packet.roll, packet.qw, packet.qx, packet.qy, packet.qz)
+          print(packet)
+
+  # Handle errors and exceptions
+  except serial.SerialException as e:
+    print(f"\nError communicating with the device: {e}")
+    print("\nExiting...")
+  except KeyboardInterrupt:
+    print("\nKeyboard interrupt detected. Exiting...")
+
+
+# Application entry point
+def main():
+
+  # Parse command line arguments and start the main loop
+  parser = argparse.ArgumentParser(description="CivicAlert Streaming Data Capture and Visualization Tool")
+  parser.add_argument("-i", "--imu", help="visualize streaming IMU data", default=False, action='store_true')
+  parser.add_argument("-c", "--channels", help="number of channels", default=1, type=int)
+  args = parser.parse_args()
+  main_loop(args.imu, args.channels)
+  pygame.quit()
+
+if __name__ == '__main__':
+  main()

civicstream-1.0.0/civicstream.egg-info/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: civicstream
+Version: 1.0.0
+Summary: CivicAlert Streaming Data Capture and Visualization Tool
+Home-page: https://github.com/vu-civic/tools
+Author: Will Hedgecock
+Author-email: ronald.w.hedgecock@vanderbilt.edu
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pyserial
+Requires-Dist: pygame
+Requires-Dist: PyOpenGL
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+CivicStream
+===========
+
+This package provides a command-line tool for capturing and visualizing streaming data
+from a CivicAlert sensor device. It can be accessed from a command terminal by entering:
+
+``civicstream``
+
+Enter ``civicstream -h`` to see a listing of available command line parameters, including
+activation of an IMU visualizer or configuration of the number of incoming audio channels.

civicstream-1.0.0/civicstream.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+MANIFEST.in
+README.rst
+setup.py
+app/__init__.py
+app/civicstream.py
+civicstream.egg-info/PKG-INFO
+civicstream.egg-info/SOURCES.txt
+civicstream.egg-info/dependency_links.txt
+civicstream.egg-info/entry_points.txt
+civicstream.egg-info/requires.txt
+civicstream.egg-info/top_level.txt

civicstream-1.0.0/civicstream.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

civicstream-1.0.0/civicstream.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+civicstream = civicstream.civicstream:main

civicstream-1.0.0/civicstream.egg-info/requires.txt

@@ -0,0 +1,4 @@
+numpy
+pyserial
+pygame
+PyOpenGL

civicstream-1.0.0/civicstream.egg-info/top_level.txt

@@ -0,0 +1 @@
+civicstream

civicstream-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

civicstream-1.0.0/setup.py

@@ -0,0 +1,32 @@
+import setuptools
+
+with open('README.rst', 'r') as fh:
+   long_description = fh.read()
+
+setuptools.setup(
+   name='civicstream',
+   version='1.0.0',
+   author='Will Hedgecock',
+   author_email='ronald.w.hedgecock@vanderbilt.edu',
+   description='CivicAlert Streaming Data Capture and Visualization Tool',
+   long_description=long_description,
+   long_description_content_type='text/x-rst',
+   url='https://github.com/vu-civic/tools',
+   package_dir={'civicstream': 'app'},
+   packages=['civicstream'],
+   include_package_data=True,
+   install_requires=[
+      'numpy',
+      'pyserial',
+      'pygame',
+      'PyOpenGL'
+   ],
+   classifiers=[
+      'Programming Language :: Python :: 3',
+      'Operating System :: OS Independent',
+   ],
+   python_requires='>=3.8',
+   entry_points={
+      'console_scripts': ['civicstream = civicstream.civicstream:main'],
+   }
+)