Amar/feature/create simulated adcs

.gitignore

@@ -161,3 +161,5 @@ cython_debug/
 
 # MacOS
 .DS_Store
+
+.idea/

.gitignore~

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# MacOS
+.DS_Store

ADCS/.dockerignore

@@ -0,0 +1,34 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.DS_Store
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

ADCS/.gitignore

@@ -0,0 +1,2 @@
+*.un~
+*.swp

ADCS/Dockerfile

@@ -0,0 +1,49 @@
+# syntax=docker/dockerfile:1
+
+# Comments are provided throughout this file to help you get started.
+# If you need more help, visit the Dockerfile reference guide at
+# https://docs.docker.com/go/dockerfile-reference/
+
+ARG PYTHON_VERSION=3.10.13
+FROM python:${PYTHON_VERSION}-slim as base
+
+# Prevents Python from writing pyc files.
+ENV PYTHONDONTWRITEBYTECODE=1
+
+# Keeps Python from buffering stdout and stderr to avoid situations where
+# the application crashes without emitting any logs due to buffering.
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+# Create a non-privileged user that the app will run under.
+# See https://docs.docker.com/go/dockerfile-user-best-practices/
+ARG UID=10001
+RUN adduser \
+    --disabled-password \
+    --gecos "" \
+    --home "/nonexistent" \
+    --shell "/sbin/nologin" \
+    --no-create-home \
+    --uid "${UID}" \
+    appuser
+
+# Download dependencies as a separate step to take advantage of Docker's caching.
+# Leverage a cache mount to /root/.cache/pip to speed up subsequent builds.
+# Leverage a bind mount to requirements.txt to avoid having to copy them into
+# into this layer.
+RUN --mount=type=cache,target=/root/.cache/pip \
+    --mount=type=bind,source=requirements.txt,target=requirements.txt \
+    python -m pip install -r requirements.txt
+
+# Switch to the non-privileged user to run the application.
+USER appuser
+
+# Copy the source code into the container.
+COPY . .
+
+# Expose the port that the application listens on.
+EXPOSE 8838
+
+# Run the application.
+CMD python3 adcs_subsystem.py 8838 127.0.0.1

ADCS/README.md

@@ -0,0 +1,68 @@
+# ADCS Simulated Subsystem
+
+## Overview
+
+The ADCS, also known as the Altitude Determination and Control System, is a
+system that controls the orientation of ex3.
+
+The ADCS is used to help steer the satellite.
+
+## Data types
+- x,y,z angle
+  - Representable as a triplet?
+- x,y,z angular speed
+  - Same representation as the x,y,z angle?
+- ECI/ECEF/LLH position/velocity (Need definition)
+- Coarse and fine sun vector (Need definition)
+- Wheel speed
+- Magnetic Field (IMU?)
+- Comm status
+- Rate sensor temperature (sensor measuring the wheel speed?)
+
+## Payload design
+- TODO
+
+## TODO
+- [ ] Make a status report transaction code
+- [ ] Implement an echo command
+
+## Usage
+
+Note: We are missing docker setups for running the unit test. Run using your local environment for now.
+
+_There is now a dockerfile associated with this subsystem, and you are able to
+run it using the following command on powershell (please have docker installed)_
+
+
+```powershell
+docker build -t adcs_server .
+```
+
+```powershell
+docker run -dp 127.0.0.1:8838:8838 adcs_server
+```
+
+## Testing the Subsystem
+
+To test the subsystem run the adcs_server.py file, and connect to the server using some program/utility such as `nc`
+
+```bash
+nc localhost 42123 
+```
+
+From there you can send commands such as `HELP` from the client side.
+
+## Testing Table
+
+### ADCS Subsystem
+
+| Test Name | Test Description |
+| --- | --- | 
+| `test_setup` | This test makes sure that the unit testing framework, and mocked objects are functioning as expected. |
+
+### Temporary Connection Protocol
+
+| Test Name | Test Description |
+| --- | --- | 
+| `test_setup` | This test makes sure that the unit testing framework, and mocked objects are functioning as expected. |
+| `test_serializing` | This test should check if the connection protocol object is able to turn the packet object into a byte stream. |

ADCS/__init__.py

@@ -0,0 +1,2 @@
+# This file is used for imports
+from adcs_subsystem import ADCSSubsystem

ADCS/abstract_interface.py

@@ -0,0 +1,28 @@
+"""Holds the abstract class ConnectionProtocol"""
+
+
+class ConnectionProtocol:
+    """TODO: We should put the packet serialization and so on be the
+    responsibility of the connection protocol, since it will be
+    changing as we get further into the project."""
+
+    def send(self, data: bytes):
+        """
+        This method will send data. Force the input to be bytes so that the
+        caller must format the data to be bytes already.
+        """
+        raise NotImplementedError
+
+    def recv(self) -> bytes:
+        """
+        This method will recieve data. It should return it.
+
+        Fundamental assumption is that this will work with bytes
+        """
+        raise NotImplementedError
+
+    def connect(self):
+        """
+        This method will start the connection
+        """
+        raise NotImplementedError