tweaks

AstroAppHTTPAPI/Properties/AssemblyInfo.cs

@@ -13,12 +13,12 @@
 // [MANDATORY] The name of your plugin
 [assembly: AssemblyTitle("Astro HTTP API")]
 // [MANDATORY] A short description of your plugin
-[assembly: AssemblyDescription("A general HTTP API for NINA designed for use with astroapp.io")]
+[assembly: AssemblyDescription("A general purpose HTTP API for NINA designed for use with astroapp.io")]
 
 // The following attributes are not required for the plugin per se, but are required by the official manifest meta data
 
 // Your name
-[assembly: AssemblyCompany("Shrivu Shankar")]
+[assembly: AssemblyCompany("Shrivu Shankar (sshh12)")]
 // The product name that this plugin is part of
 [assembly: AssemblyProduct("Astro HTTP API")]
 [assembly: AssemblyCopyright("Copyright © 2024 Shrivu Shankar")]
@@ -51,7 +51,31 @@
 //[Optional] An additional url to an example example screenshot of your plugin in action
 [assembly: AssemblyMetadata("AltScreenshotURL", "")]
 //[Optional] An in-depth description of your plugin
-[assembly: AssemblyMetadata("LongDescription", @"")]
+[assembly: AssemblyMetadata("LongDescription", @"This plugin provides a general purpose HTTP (and websocket) server you can use to control N.I.N.A. remotely.
+
+* NOTE: This plugin is experimental and may not yet support all N.I.N.A features, in some cases it may unexpectedly crash N.I.N.A. Use at your own risk.
+
+# Features #
+
+* Control all standard device types (mount, focuser, camera, filter wheel, rotator, dome)
+* Subscribe to live events from N.I.N.A. via websockets
+* Use over the internet with tools like ngrok or cloudflare tunnels
+* Native support for astroapp.io
+
+# Quick Start #
+
+For using an existing UI, visit [astroapp.io](https://astroapp.io/image/nina).
+
+For using the API directly, see the [quick start guide](https://github.com/sshh12/astro-app-nina-api).
+
+See API docs here: [API Docs](https://github.com/sshh12/astro-app-nina-api/blob/main/API.md).
+
+# Getting Help #
+
+If you have questions, submit an issue on [GitHub](https://github.com/sshh12/astro-app-nina-api/issues) or this [form](https://forms.gle/hiaKh3HRfVBYZxiu6).
+* Astro HTTP API is provided 'as is' under the terms of the [Mozilla Public License 2.0](https://github.com/sshh12/astro-app-nina-api/blob/main/LICENSE)
+* Source code for this plugin is available at this plugin's [repository](https://github.com/sshh12/astro-app-nina-api)
+")]
 
 // Setting ComVisible to false makes the types in this assembly not visible
 // to COM components.  If you need to access a type in this assembly from

README.md

@@ -1,2 +1,86 @@
 # Astro HTTP API
 
+> Astro HTTP API is a general purpose HTTP API for NINA designed for use with astroapp.io
+
+## Local Network Setup
+
+1. Install this plugin either directly from N.I.N.A. or by downloading the latest release from the [releases page](https://github.com/sshh12/astro-app-nina-api/releases) and extracting it into `%localappdata%\NINA\Plugins`
+2. On the plugin page, set `Web Server Enabled`
+3. Find your local IP address by running `ipconfig` in Command Prompt (typically `192.168.x.x` or `10.x.x.x`)
+4. Open your browser and navigate to `http://<local-ip>:<port>` where `<local-ip>` is your local IP address and `<port>` is the port you set in the plugin settings (default is `8181`). It should prompt for a login and you'll see the user/password in the plugin settings.
+
+By default, you'll only be able to access the API from your local network (e.g. same WiFi network).
+
+## Remote Network Setup
+
+There are a ton of options for exposing this server to the internet and allowing N.I.N.A. to be controlled from anywhere. See [awesome-tunneling](https://github.com/anderspitman/awesome-tunneling) for list of options.
+
+The typical best option is cloudflare tunnels. It's free and easy to setup. You can find a guide [here](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/).
+
+Keep in mind that exposing your N.I.N.A. server to the internet can be a security risk. It's recommended to not run this server for long periods of time (24/7) if you have sensitive data on the same system that N.I.N.A. is running on.
+
+## Example Usage
+
+> For full endpoint documentation see the [API Documentation](https://github.com/sshh12/astro-app-nina-api/blob/main/API.md).
+
+### Python
+
+```python
+import requests
+
+status = requests.post(
+    "http://localhost:8181/api/v1/camera/capture", 
+    auth=("user", "#password#"), 
+    json={"ExposureTime": 1.0}
+).json()
+print(status)
+```
+
+```python
+import websockets
+import asyncio
+import json
+
+async def connect():
+    async with websockets.connect("ws://localhost:8181/events/v1") as websocket:
+        await asyncio.sleep(0.1)
+        await websocket.send(json.dumps({'ApiKey': '#password#'}))
+        while True:
+            try:
+                event = json.loads(await websocket.recv())
+                print(event)
+            except websockets.ConnectionClosed:
+                break
+
+asyncio.run(connect())
+```
+
+### JavaScript
+
+```javascript
+fetch("http://localhost:8181/api/v1/camera/capture", {
+    method: "POST",
+    headers: {
+        "Authorization": "Basic " + btoa("user:#password#"),
+        "Content-Type": "application/json"
+    },
+    body: JSON.stringify({ExposureTime: 1.0})
+}).then(res => res.json()).then(console.log)
+```
+
+```javascript
+const ws = new WebSocket("ws://localhost:8181/events/v1")
+
+ws.onopen = () => ws.send(JSON.stringify({ApiKey: "#password#"}))
+ws.onmessage = event => console.log(JSON.parse(event.data))
+```
+
+## Help & Feature Requests
+
+There are plenty of N.I.N.A. features that are not yet implemented in this API just because I wasn't using them. If you need a feature that is not yet implemented, please let me know and I can add it.
+
+Submit an issue on [GitHub](https://github.com/sshh12/astro-app-nina-api/issues) or this [form](https://forms.gle/hiaKh3HRfVBYZxiu6).
+
+## Acknowledgements
+
+Shout out to https://github.com/christian-photo/ninaAPI which was used as a reference for this project.