Api v2 for dwafII

.eslintrc.json

@@ -4,5 +4,10 @@
     "sourceType": "module",
     "ecmaVersion": 2020
   },
+  "env": {
+    "node":true
+  },
+  // Add an exception for the generated protobuf.js file
+  "ignorePatterns": ["src/protobuf/protobuf/*.*", "src/proto/*.*"],
   "root": true
 }

README.md

@@ -1,84 +1,103 @@
 # Dwarf II
 
-Wrapper functions for Dwarf II (aka Dwarf 2) API V1. This library and the API are a work in progress.
+Wrapper functions for Dwarf II (aka Dwarf 2) API V2.
 
-Dwarf Lab's [API V1 documentation](https://hj433clxpv.feishu.cn/docx/MiRidJmKOobM2SxZRVGcPCVknQg).
+Dwarf Lab's [API V2 documentation](https://tinyphoton.feishu.cn/docx/GBkcdldTIo3SrdxFJDscYVYDnvf?fbclid=IwAR0_Vypm8DPk1PPtwllptpWDZmxbCgi3NKVQKV8khDXIvnNay_o67AUgtq4).
 
-[Documentation](https://dwarftelescopeusers.github.io/dwarfii_api/) for this package.
+[Documentation](https://stevejcl.github.io/dwarfii_api/) for this package.
 
 ## Install
 
 ```
 npm install dwarfii_api
 ```
 
+## Install for Javascript
+Using this library in pure javascript is possible.
+Use the dist_js repertory and follow the instructions in the file index.html
+
 ## Usage
 
-The Dwarf API uses websockets. The URL of the websockets depends on if you use Dwarf wifi or if you use the Dwarf in STA mode.
+The Dwarf API uses websockets with binary protobuf format. 
+
+The URL of the websockets depends on if you use Dwarf wifi or if you use the Dwarf in STA mode.
 
-Example of sending a Goto command using the Dwarf wifi.
+Example of sending a Goto command.
 
 ```js
-import { startGoto, wsURL, DwarfIP, socketSend } from "dwarfii_api";
-
-const socket = new WebSocket(wsURL(DwarfIP));
-socket.addEventListener("open", () => {
-  let planet = null;
-  let RA = 10.6;
-  let dec = 41.2;
-  let lat = 40.0;
-  let lon = 90.0;
-  let options = startGoto(planet, RA, dec, lat, lon);
-  socketSend(socket, options);
-});
-
-socket.addEventListener("message", (event) => {
-  let message = JSON.parse(event.data);
-  console.log(message);
-});
-
-socket.addEventListener("error", (message) => {
-  console.log("error:", message);
-});
-```
+import { messageAstroStartGotoDso, WebSocketHandler } from "dwarfii_api";
+
+// Create WebSocketHandler if need
+const webSocketHandler = new WebSocketHandler(IPDwarf);
+
+// define a customMessageHandler to handle the message in return send by the API
+let goto_end_status = false;
+
+const customMessageHandler = (txt_info, result_data) => {
+  if ( result_data.cmd == Dwarfii_Api.DwarfCMD.CMD_ASTRO_START_GOTO_DSO ) {
+    if (result_data.data.code != Dwarfii_Api.DwarfErrorCode.OK) {
+      console.error("Error GOTO : " + result_data.data.errorTxt);
+      if (
+        result_data.data.code ==
+          Dwarfii_Api.DwarfErrorCode.CODE_ASTRO_GOTO_FAILED ||
+        result_data.data.code ==
+          Dwarfii_Api.DwarfErrorCode.CODE_ASTRO_FUNCTION_BUSY
+      )
+        goto_end_status = true;
+    }
+  } else if (
+    !goto_end_status &&
+    result_data.cmd == Dwarfii_Api.DwarfCMD.CMD_NOTIFY_STATE_ASTRO_GOTO
+  ) {
+      console.log(result_data.data.stateText);
+    }
+  } else if (
+    !goto_end_status &&
+    result_data.cmd == Dwarfii_Api.DwarfCMD.CMD_NOTIFY_STATE_ASTRO_TRACKING
+  ) {
+    if (
+      result_data.data.state ==
+        Dwarfii_Api.OperationState.OPERATION_STATE_RUNNING &&
+      result_data.data.targetName == targetName
+    ) {
+        goto_end_status = true;
+        console.info("Start Tracking");
+      }
+  } else {
+    // other frame result
+    console.log(txt_info + ": " + result_data);
+    return;
+  }
+  // log frame result
+  console.log(txt_info + ": " + result_data);
+};
+
+
+let txtInfoCommand = "Start Goto";
+
+// create a packet message for the command, you can send a tabs of Packets also
+let WS_Packet = messageAstroStartGotoDso(
+  RA_number,
+  declination_number,
+  targetName
+);
+
+// prepre the messages to send
+webSocketHandler.prepare(
+  WS_Packet,
+  txtInfoCommand,
+  // Tab of commands to listen to, can be "*" for getting All received Data
+  // the others are not sending back to customMessageHandler
+  [
+    Dwarfii_Api.DwarfCMD.CMD_ASTRO_START_GOTO_DSO,
+    Dwarfii_Api.DwarfCMD.CMD_NOTIFY_STATE_ASTRO_GOTO,
+    Dwarfii_Api.DwarfCMD.CMD_NOTIFY_STATE_ASTRO_TRACKING,
+  ],
+  customMessageHandler
+);
+// start sending and receiving
+if (!webSocketHandler.run()) {
+  console.error(" Can't launch Web Socket Run Action!");
+}
 
-Example of sending a take astro photos command using the Dwarf in STA mode. You need to provide the IP of your Dwarf II.
 
-```js
-import {
-  wsURL,
-  socketSend,
-  binning2x2,
-  takeAstroPhoto,
-  fileFits,
-} from "dwarfii_api";
-
-let myIP = "192.123.45.6";
-const socket = new WebSocket(wsURL(myIP));
-socket.addEventListener("open", () => {
-  let RA = 10.6;
-  let dec = 41.2;
-  let exposure = 10;
-  let gain = 60;
-  let count = 100;
-  let options = takeAstroPhoto(
-    RA,
-    dec,
-    exposure,
-    gain,
-    binning2x2,
-    count,
-    fileFits
-  );
-  socketSend(socket, options);
-});
-
-socket.addEventListener("message", (event) => {
-  let message = JSON.parse(event.data);
-  console.log(message);
-});
-
-socket.addEventListener("error", (message) => {
-  console.log("error:", message);
-});
-```

dist/index.d.ts

@@ -1,12 +1,13 @@
 export * from "./src/api_codes.js";
 export * from "./src/api_utils.js";
 export * from "./src/astro.js";
-export * from "./src/camera_settings.js";
-export * from "./src/image_transmission.js";
-export * from "./src/motion_control.js";
-export * from "./src/panoramic.js";
-export * from "./src/photo_video.js";
-export * from "./src/set_isp_settings.js";
-export * from "./src/system_settings.js";
-export * from "./src/tracking.js";
+export * from "./src/camera_tele.js";
+export * from "./src/camera_wide.js";
+export * from "./src/panorama.js";
+export * from "./src/focus.js";
+export * from "./src/rgb_power.js";
+export * from "./src/system.js";
+export * from "./src/websocket_class.js";
+export * from "./src/bluetooth.js";
+export * from "./src/motor.js";
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -1,11 +1,12 @@
 export * from "./src/api_codes.js";
 export * from "./src/api_utils.js";
 export * from "./src/astro.js";
-export * from "./src/camera_settings.js";
-export * from "./src/image_transmission.js";
-export * from "./src/motion_control.js";
-export * from "./src/panoramic.js";
-export * from "./src/photo_video.js";
-export * from "./src/set_isp_settings.js";
-export * from "./src/system_settings.js";
-export * from "./src/tracking.js";
+export * from "./src/camera_tele.js";
+export * from "./src/camera_wide.js";
+export * from "./src/panorama.js";
+export * from "./src/focus.js";
+export * from "./src/rgb_power.js";
+export * from "./src/system.js";
+export * from "./src/websocket_class.js";
+export * from "./src/bluetooth.js";
+export * from "./src/motor.js";

dist/src/api_codes.d.ts

@@ -4,37 +4,14 @@ export function wsURL(IP: string): string;
 export function wideangleURL(IP: string): string;
 export function telephotoURL(IP: string): string;
 export function rawPreviewURL(IP: string): string;
-export function utcURL(IP: string): string;
-export const turnOnCameraCmd: 10000;
-export const turnOffCameraCmd: 10017;
-export const telephotoCamera: 0;
-export const wideangleCamera: 1;
-export const previewImageQuality: 10016;
-export const takePhotoCmd: 10006;
-export const photoSingleShot: 0;
-export const photoContinuous: 1;
-export const startRecordingCmd: 10007;
-export const stopRecordingCmd: 10009;
-export const startTimelapseCmd: 10018;
-export const stopTimelapseCmd: 10019;
+export function firmwareVersion(IP: string): string;
+export function getDefaultParamsConfig(IP: string): string;
 export const modeAuto: 0;
 export const modeManual: 1;
-export const setBrightnessValueCmd: 10204;
-export const setContrastValueCmd: 10205;
-export const setSaturationValueCmd: 10206;
-export const setHueValueCmd: 10207;
-export const setSharpnessValueCmd: 10208;
-export const setExposureModeCmd: 10001;
-export const setExposureValueCmd: 10003;
-export const exposureTelephotoModeAuto: 0;
-export const exposureWideangleModeAuto: 3;
-export const setGainModeCmd: 10004;
-export const setGainValueCmd: 10005;
-export const autofocusCmd: 10211;
 export const autofocusGlobal: 0;
 export const autofocusArea: 1;
-export const setWhiteBalanceModeCmd: 10212;
-export const setWhiteBalanceScenceCmd: 10213;
+export const exposureTelephotoModeAuto: 0;
+export const exposureWideangleModeAuto: 3;
 export const whiteBalanceScenesIDValue: {
     0: string;
     1: string;
@@ -45,81 +22,29 @@ export const whiteBalanceScenesIDValue: {
     6: string;
 };
 export const whiteBalanceScenesValueID: {
-    "incandescent lamp": number;
-    "fluorescent lamp": number;
-    "warm fluorescent lamp": number;
+    incandescent: number;
+    "warm fluorescent": number;
+    fluorescent: number;
     sunlight: number;
-    "overcast sky": number;
-    "evening twilight": number;
+    cloudy: number;
     shadow: number;
+    twilight: number;
 };
-export const setWhiteBalanceColorCmd: 10214;
-export const setIRCmd: 10203;
 export const IRCut: 0;
-export const IRPass: 3;
-export const statusTelephotoCmd: 10215;
-export const statusIRTelephotoCmd: 10216;
-export const statusWorkingStateTelephotoCmd: 10022;
-export const statusWideangleCmd: 10217;
-export const calibrateGotoCmd: 11205;
-export const startGotoCmd: 11203;
-export namespace planetsValueId {
-    let Mercury: number;
-    let Venus: number;
-    let Mars: number;
-    let Jupiter: number;
-    let Saturn: number;
-    let Uranus: number;
-    let Neptune: number;
-    let Moon: number;
-}
-export const planetsIdValue: {
-    0: string;
-    1: string;
-    2: string;
-    3: string;
-    4: string;
-    5: string;
-    6: string;
-    7: string;
-};
-export const takeAstroPhotoCmd: 10011;
-export const stopAstroPhotoCmd: 10015;
+export const IRPass: 1;
 export const binning1x1: 0;
 export const binning2x2: 1;
 export const fileFits: 0;
 export const fileTiff: 1;
-export const numberRawImagesCmd: 10014;
-export const numberSuperImposedImages: 10023;
-export const setRAWPreviewCmd: 10020;
 export const rawPreviewContinousSuperimpose: 0;
 export const rawPreviewSingle15: 1;
 export const rawPreviewSingleComposite: 2;
-export const takeAstroDarkFramesCmd: 10026;
-export const darkGainDefault: 65528;
-export const queryShotFieldCmd: 10027;
-export const traceInitCmd: 11200;
-export const startTrackingCmd: 11201;
-export const stopTrackingCmd: 11202;
-export const startPanoCmd: 10103;
-export const stopPanoCmd: 10106;
-export const startMotionCmd: 10100;
 export const continuous_mode: 1;
 export const pulse_mode: 2;
-export const stopMotionCmd: 10101;
-export const setSpeedCmd: 10107;
 export const speedDecelerate: 0;
 export const speedAccelerate: 1;
-export const setDirectionCmd: 10108;
 export const anticlockwise: 0;
 export const clockwise: 1;
-export const setSubdivideCmd: 10109;
 export const spinMotor: 1;
 export const pitchMotor: 2;
-export const systemStatusCmd: 11407;
-export const microsdStatusCmd: 11405;
-export const microsdAvailableCmd: 11409;
-export const dwarfSoftwareVersionCmd: 11410;
-export const dwarfChargingStatusCmd: 11011;
-export const shutDownCmd: 11004;
 //# sourceMappingURL=api_codes.d.ts.map