new doc

index.ts

@@ -1,27 +1,53 @@
-import { openPromisified } from "i2c-bus";
+import { openPromisified } from 'i2c-bus';
 
+/**
+ * I2C Port Map Max サイズ
+ */
 const I2CPortMapSizeMax = 32;
 
+/**
+ * Uint16 Max サイズ
+ */
 const Uint16Max = 65535;
 
-function parseUint16(string: string) {
-  const n = Number.parseInt(string, 10);
+/**
+ *
+ * Uint16型変換処理
+ * @param parseString 変換文字列
+ * @return Uint16型変換値
+ */
+function parseUint16(parseString: string) {
+  const n = Number.parseInt(parseString, 10);
   if (0 <= n && n <= Uint16Max) return n;
   else throw new RangeError(`Must be between 0 and ${Uint16Max}.`);
 }
 
+/** ポート番号 */
 type PortNumber = number;
+/** ポート名 */
 type PortName = string;
 
+/** I2C Slave アドレス */
 type I2CSlaveAddress = number;
 
+/**
+ * I2CAccess クラス定義
+ */
 export class I2CAccess {
   private readonly _ports: I2CPortMap;
 
+  /**
+   * Creates an instance of GPIOAccess.
+   * @param ports ポート番号
+   */
   constructor(ports?: I2CPortMap) {
     this._ports = ports == null ? new I2CPortMap() : ports;
   }
 
+  /**
+   * ポート情報取得処理
+   * @return 現在のポート情報
+   */
   get ports(): I2CPortMap {
     return this._ports;
   }
@@ -35,21 +61,41 @@ export class I2CPortMap extends Map<PortNumber, I2CPort> {
   }
 }
 
+/**
+ * I2CPort クラス定義
+ */
 export class I2CPort {
   private readonly _portNumber: PortNumber;
 
+  /**
+   * Creates an instance of GPIOPort.
+   * @param portNumber ポート番号
+   */
   constructor(portNumber: PortNumber) {
     this._portNumber = parseUint16(portNumber.toString());
   }
 
+  /**
+   * ポート番号取得処理
+   * @return 現在のポート番号
+   */
   get portNumber(): PortNumber {
     return this._portNumber;
   }
 
+  /**
+   * ポート名取得処理
+   * @return 現在のポート名
+   */
   get portName(): string {
     return `i2c-${this.portNumber}`;
   }
 
+  /**
+   * I2CSlave 接続デバイスオープン処理
+   * @param slaveAddress 接続デバイス情報のアドレス
+   * @return I2CSlave 接続デバイス情報の Promise
+   */
   async open(slaveAddress: I2CSlaveAddress): Promise<I2CSlaveDevice> {
     const bus = await openPromisified(this.portNumber).catch((error) => {
       throw new OperationError(error);
@@ -57,32 +103,57 @@ export class I2CPort {
 
     return {
       slaveAddress,
-      read8: (cmd) =>
-        bus.readByte(slaveAddress, cmd).catch((error) => {
+      /**
+       * @function
+       * I2c 8bit 読み取り処理
+       * @param registerNumber 読み取りアドレス
+       */
+      read8: (registerNumber) =>
+        bus.readByte(slaveAddress, registerNumber).catch((error) => {
           throw new OperationError(error);
         }),
-      read16: (cmd) =>
-        bus.readWord(slaveAddress, cmd).catch((error) => {
+      /**
+       * @function
+       * I2c 16bit 読み取り処理
+       * @param registerNumber 読み取りアドレス
+       */
+      read16: (registerNumber) =>
+        bus.readWord(slaveAddress, registerNumber).catch((error) => {
           throw new OperationError(error);
         }),
-      write8: async (cmd, byte) => {
+      /**
+       * @function
+       * I2c 8bit 書き込み処理
+       * @param registerNumber 書き込みアドレス
+       * @param byte 書き込みの値（バイト）
+       */
+      write8: async (registerNumber, byte) => {
         try {
-          await bus.writeByte(slaveAddress, cmd, byte);
+          await bus.writeByte(slaveAddress, registerNumber, byte);
           return byte;
         } catch (error: any) {
           throw new OperationError(error);
         }
       },
-      write16: async (cmd, word) => {
+      /**
+       * @function
+       * I2c 16bit 書き込み処理
+       * @param registerNumber 書き込みアドレス
+       * @param word 書き込みの値（ワード）
+       */
+      write16: async (registerNumber, word) => {
         try {
-          await bus.writeWord(slaveAddress, cmd, word);
+          await bus.writeWord(slaveAddress, registerNumber, word);
           return word;
         } catch (error: any) {
           throw new OperationError(error);
         }
       },
-
-      /** Different from Web I2C API specification. */
+      /**
+       * @function
+       * I2c 16bit 読み取りバイト処理
+       * Different from Web I2C API specification.
+       */
       readByte: async () => {
         try {
           const byte = await bus.receiveByte(slaveAddress);
@@ -91,7 +162,12 @@ export class I2CPort {
           throw new OperationError(error);
         }
       },
-      /** Different from Web I2C API specification. */
+      /**
+       * @function
+       * I2c 16bit 読み取りバイト処理
+       * Different from Web I2C API specification.
+       * @param length バイト長
+       */
       readBytes: async (length) => {
         try {
           const { bytesRead, buffer } = await bus.i2cRead(
@@ -104,7 +180,12 @@ export class I2CPort {
           throw new OperationError(error);
         }
       },
-      /** Different from Web I2C API specification. */
+      /**
+       * @function
+       * I2c 16bit 書き込みバイト処理
+       * Different from Web I2C API specification.
+       * @param registerNumber 読み取りアドレス
+       */
       writeByte: async (byte) => {
         try {
           await bus.sendByte(slaveAddress, byte);
@@ -113,7 +194,12 @@ export class I2CPort {
           throw new OperationError(error);
         }
       },
-      /** Different from Web I2C API specification. */
+      /**
+       * @function
+       * I2c 16bit 書き込みバイト配列処理
+       * Different from Web I2C API specification.
+       * @param byte バイトサイズ配列
+       */
       writeBytes: async (bytes) => {
         try {
           const { bytesWritten, buffer } = await bus.i2cWrite(
@@ -130,32 +216,88 @@ export class I2CPort {
   }
 }
 
+/**
+ * I2CSlaveDevice クラス定義
+ */
 export interface I2CSlaveDevice {
+  /** I2C Slave アドレス */
   readonly slaveAddress: I2CSlaveAddress;
 
+  /**
+   * @function
+   * I2c 8bit 読み取り処理
+   * @param registerNumber 読み取りアドレス
+   */
   read8(registerNumber: number): Promise<number>;
+  /**
+   * @function
+   * I2c 16bit 読み取り処理
+   * @param registerNumber 読み取りアドレス
+   */
   read16(registerNumber: number): Promise<number>;
+  /**
+   * @function
+   * I2c 8bit 書き込み処理
+   * @param registerNumber 書き込みアドレス
+   * @param byte 書き込みの値（バイト）
+   */
   write8(registerNumber: number, value: number): Promise<number>;
+  /**
+   * @function
+   * I2c 16bit 書き込み処理
+   * @param registerNumber 書き込みアドレス
+   * @param word 書き込みの値（ワード）
+   */
   write16(registerNumber: number, value: number): Promise<number>;
 
-  /** Different from Web I2C API specification. */
+  /**
+   * @function
+   * I2c 16bit 読み取りバイト処理
+   * Different from Web I2C API specification.
+   */
   readByte(): Promise<number>;
-  /** Different from Web I2C API specification. */
+  /**
+   * @function
+   * I2c 16bit 読み取りバイト処理
+   * Different from Web I2C API specification.
+   * @param length バイト長
+   */
   readBytes(length: number): Promise<Uint8Array>;
-  /** Different from Web I2C API specification. */
+  /**
+   * @function
+   * I2c 16bit 書き込みバイト処理
+   * Different from Web I2C API specification.
+   * @param byte バイトサイズ
+   */
   writeByte(byte: number): Promise<number>;
-  /** Different from Web I2C API specification. */
+  /**
+   * @function
+   * I2c 16bit 書き込みバイト配列処理
+   * Different from Web I2C API specification.
+   * @param byte バイトサイズ配列
+   */
   writeBytes(bytes: Array<number>): Promise<Uint8Array>;
 }
 
+/**
+ * 操作エラークラス定義
+ */
 export class OperationError extends Error {
+  /**
+   * Creates an instance of OperationError.
+   * @param message エラーメッセージ
+   */
   constructor(message: string) {
     super(message);
     this.name = this.constructor.name;
   }
 }
 
-// Web I2Cの仕様に基づく意図的なasync関数の使用なので、ルールを無効化
+/**
+ * requestGPIOAccess 関数
+ * Web I2Cの仕様に基づく意図的なasync関数の使用なので、ルールを無効化
+ * @return I2CAccess インスタンス生成結果 Promise
+ */
 // eslint-disable-next-line
 export async function requestI2CAccess(): Promise<I2CAccess> {
   const ports = new I2CPortMap(