diff --git a/docs/README.md b/docs/README.md index b0417a2..5a36e49 100644 --- a/docs/README.md +++ b/docs/README.md @@ -195,7 +195,7 @@ describe('Device', () => { ▸ **Bus**(__namedParameters?: *`object`*): [BusInterface](interfaces/businterface.md) -*Defined in [lib/Bus.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/Bus.ts#L8)* +*Defined in [lib/Bus.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/Bus.ts#L8)* **Parameters:** @@ -215,7 +215,7 @@ ___ ▸ **Device**(__namedParameters: *`object`*): [DeviceInterface](interfaces/deviceinterface.md) -*Defined in [lib/Device.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/Device.ts#L4)* +*Defined in [lib/Device.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/Device.ts#L4)* **Parameters:** @@ -235,7 +235,7 @@ ___ ▸ **createI2cBusMock**(__namedParameters?: *`object`*): `open` -*Defined in [lib/createI2cBusMock.ts:24](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L24)* +*Defined in [lib/createI2cBusMock.ts:24](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L24)* **Parameters:** @@ -258,7 +258,7 @@ ___ **defaultI2cBusFuncs**: *`object`* -*Defined in [lib/createI2cBusMock.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L3)* +*Defined in [lib/createI2cBusMock.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L3)* @@ -266,7 +266,7 @@ ___ **● i2c**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L4)* +*Defined in [lib/createI2cBusMock.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L4)* ___ @@ -275,7 +275,7 @@ ___ **● protocolMangling**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:6](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L6)* +*Defined in [lib/createI2cBusMock.ts:6](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L6)* ___ @@ -284,7 +284,7 @@ ___ **● smbusBlockProcCall**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L8)* +*Defined in [lib/createI2cBusMock.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L8)* ___ @@ -293,7 +293,7 @@ ___ **● smbusPec**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L7)* +*Defined in [lib/createI2cBusMock.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L7)* ___ @@ -302,7 +302,7 @@ ___ **● smbusProcCall**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L16)* +*Defined in [lib/createI2cBusMock.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L16)* ___ @@ -311,7 +311,7 @@ ___ **● smbusQuick**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:9](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L9)* +*Defined in [lib/createI2cBusMock.ts:9](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L9)* ___ @@ -320,7 +320,7 @@ ___ **● smbusReadBlock**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L17)* +*Defined in [lib/createI2cBusMock.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L17)* ___ @@ -329,7 +329,7 @@ ___ **● smbusReadByte**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:12](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L12)* +*Defined in [lib/createI2cBusMock.ts:12](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L12)* ___ @@ -338,7 +338,7 @@ ___ **● smbusReadI2cBlock**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L19)* +*Defined in [lib/createI2cBusMock.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L19)* ___ @@ -347,7 +347,7 @@ ___ **● smbusReadWord**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L14)* +*Defined in [lib/createI2cBusMock.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L14)* ___ @@ -356,7 +356,7 @@ ___ **● smbusReceiveByte**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L10)* +*Defined in [lib/createI2cBusMock.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L10)* ___ @@ -365,7 +365,7 @@ ___ **● smbusSendByte**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L11)* +*Defined in [lib/createI2cBusMock.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L11)* ___ @@ -374,7 +374,7 @@ ___ **● smbusWriteBlock**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L18)* +*Defined in [lib/createI2cBusMock.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L18)* ___ @@ -383,7 +383,7 @@ ___ **● smbusWriteByte**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L13)* +*Defined in [lib/createI2cBusMock.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L13)* ___ @@ -392,7 +392,7 @@ ___ **● smbusWriteI2cBlock**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L20)* +*Defined in [lib/createI2cBusMock.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L20)* ___ @@ -401,7 +401,7 @@ ___ **● smbusWriteWord**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:15](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L15)* +*Defined in [lib/createI2cBusMock.ts:15](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L15)* ___ @@ -410,7 +410,7 @@ ___ **● tenBitAddr**: *`boolean`* = false -*Defined in [lib/createI2cBusMock.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/createI2cBusMock.ts#L5)* +*Defined in [lib/createI2cBusMock.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/createI2cBusMock.ts#L5)* ___ diff --git a/docs/classes/buserror.md b/docs/classes/buserror.md index de5220d..43fa44a 100644 --- a/docs/classes/buserror.md +++ b/docs/classes/buserror.md @@ -32,7 +32,7 @@ ⊕ **new BusError**(message: *`string`*, busNumber: *`number`*): [BusError](buserror.md) -*Defined in [lib/BusError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusError.ts#L2)* +*Defined in [lib/BusError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusError.ts#L2)* **Parameters:** @@ -53,7 +53,7 @@ ___ **● busNumber**: *`number`* -*Defined in [lib/BusError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusError.ts#L2)* +*Defined in [lib/BusError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusError.ts#L2)* ___ diff --git a/docs/classes/deviceerror.md b/docs/classes/deviceerror.md index d48ed55..2b0298a 100644 --- a/docs/classes/deviceerror.md +++ b/docs/classes/deviceerror.md @@ -33,7 +33,7 @@ ⊕ **new DeviceError**(message: *`string`*, busNumber: *`number`*, deviceAddress: *`number`*): [DeviceError](deviceerror.md) -*Defined in [lib/DeviceError.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceError.ts#L3)* +*Defined in [lib/DeviceError.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceError.ts#L3)* **Parameters:** @@ -55,7 +55,7 @@ ___ **● busNumber**: *`number`* -*Defined in [lib/DeviceError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceError.ts#L2)* +*Defined in [lib/DeviceError.ts:2](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceError.ts#L2)* ___ @@ -64,7 +64,7 @@ ___ **● deviceAddress**: *`number`* -*Defined in [lib/DeviceError.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceError.ts#L3)* +*Defined in [lib/DeviceError.ts:3](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceError.ts#L3)* ___ diff --git a/docs/interfaces/businterface.md b/docs/interfaces/businterface.md index 1cb90a7..5893765 100644 --- a/docs/interfaces/businterface.md +++ b/docs/interfaces/businterface.md @@ -41,7 +41,7 @@ **● busNumber**: *`number`* -*Defined in [lib/BusInterface.ts:6](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L6)* +*Defined in [lib/BusInterface.ts:6](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L6)* ___ @@ -51,7 +51,7 @@ ___ **● i2cBus**: * [I2cBusPromised](i2cbuspromised.md) | `null` * -*Defined in [lib/BusInterface.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L7)* +*Defined in [lib/BusInterface.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L7)* ___ @@ -60,7 +60,7 @@ ___ **● isOpen**: *`boolean`* -*Defined in [lib/BusInterface.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L8)* +*Defined in [lib/BusInterface.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L8)* ___ @@ -72,7 +72,7 @@ ___ ▸ **close**(): `Promise`<[BusInterface](businterface.md)> -*Defined in [lib/BusInterface.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L11)* +*Defined in [lib/BusInterface.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L11)* **Returns:** `Promise`<[BusInterface](businterface.md)> @@ -83,7 +83,7 @@ ___ ▸ **i2cFuncs**(): `Promise`<`I2cBusFuncs`> -*Defined in [lib/BusInterface.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L13)* +*Defined in [lib/BusInterface.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L13)* **Returns:** `Promise`<`I2cBusFuncs`> @@ -94,7 +94,7 @@ ___ ▸ **i2cRead**(address: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L16)* +*Defined in [lib/BusInterface.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L16)* **Parameters:** @@ -113,7 +113,7 @@ ___ ▸ **i2cWrite**(address: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L17)* +*Defined in [lib/BusInterface.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L17)* **Parameters:** @@ -132,7 +132,7 @@ ___ ▸ **open**(): `Promise`<[BusInterface](businterface.md)> -*Defined in [lib/BusInterface.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L10)* +*Defined in [lib/BusInterface.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L10)* **Returns:** `Promise`<[BusInterface](businterface.md)> @@ -143,7 +143,7 @@ ___ ▸ **readByte**(address: *`number`*, command: *`number`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:22](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L22)* +*Defined in [lib/BusInterface.ts:22](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L22)* **Parameters:** @@ -161,7 +161,7 @@ ___ ▸ **readI2cBlock**(address: *`number`*, command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:23](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L23)* +*Defined in [lib/BusInterface.ts:23](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L23)* **Parameters:** @@ -181,7 +181,7 @@ ___ ▸ **readWord**(address: *`number`*, command: *`number`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:24](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L24)* +*Defined in [lib/BusInterface.ts:24](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L24)* **Parameters:** @@ -199,7 +199,7 @@ ___ ▸ **receiveByte**(address: *`number`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L19)* +*Defined in [lib/BusInterface.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L19)* **Parameters:** @@ -216,7 +216,7 @@ ___ ▸ **scan**(): `Promise`<`number`[]> -*Defined in [lib/BusInterface.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L14)* +*Defined in [lib/BusInterface.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L14)* **Returns:** `Promise`<`number`[]> @@ -227,7 +227,7 @@ ___ ▸ **sendByte**(address: *`number`*, byte: *`number`*): `Promise`<`void`> -*Defined in [lib/BusInterface.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L20)* +*Defined in [lib/BusInterface.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L20)* **Parameters:** @@ -245,7 +245,7 @@ ___ ▸ **writeByte**(address: *`number`*, command: *`number`*, byte: *`number`*): `Promise`<`void`> -*Defined in [lib/BusInterface.ts:26](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L26)* +*Defined in [lib/BusInterface.ts:26](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L26)* **Parameters:** @@ -264,7 +264,7 @@ ___ ▸ **writeI2cBlock**(address: *`number`*, command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/BusInterface.ts:28](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L28)* +*Defined in [lib/BusInterface.ts:28](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L28)* **Parameters:** @@ -284,7 +284,7 @@ ___ ▸ **writeWord**(address: *`number`*, command: *`number`*, word: *`number`*): `Promise`<`void`> -*Defined in [lib/BusInterface.ts:27](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/BusInterface.ts#L27)* +*Defined in [lib/BusInterface.ts:27](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/BusInterface.ts#L27)* **Parameters:** diff --git a/docs/interfaces/deviceinterface.md b/docs/interfaces/deviceinterface.md index 2451009..c526e72 100644 --- a/docs/interfaces/deviceinterface.md +++ b/docs/interfaces/deviceinterface.md @@ -36,7 +36,7 @@ **● address**: *`number`* -*Defined in [lib/DeviceInterface.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L4)* +*Defined in [lib/DeviceInterface.ts:4](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L4)* ___ @@ -45,7 +45,7 @@ ___ **● bus**: *[BusInterface](businterface.md)* -*Defined in [lib/DeviceInterface.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L5)* +*Defined in [lib/DeviceInterface.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L5)* ___ @@ -57,7 +57,7 @@ ___ ▸ **i2cRead**(length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L7)* +*Defined in [lib/DeviceInterface.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L7)* **Parameters:** @@ -75,7 +75,7 @@ ___ ▸ **i2cWrite**(length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L8)* +*Defined in [lib/DeviceInterface.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L8)* **Parameters:** @@ -93,7 +93,7 @@ ___ ▸ **readByte**(command: *`number`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L13)* +*Defined in [lib/DeviceInterface.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L13)* **Parameters:** @@ -110,7 +110,7 @@ ___ ▸ **readI2cBlock**(command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L14)* +*Defined in [lib/DeviceInterface.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L14)* **Parameters:** @@ -129,7 +129,7 @@ ___ ▸ **readWord**(command: *`number`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:15](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L15)* +*Defined in [lib/DeviceInterface.ts:15](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L15)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **receiveByte**(): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L10)* +*Defined in [lib/DeviceInterface.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L10)* **Returns:** `Promise`<`number`> @@ -157,7 +157,7 @@ ___ ▸ **sendByte**(byte: *`number`*): `Promise`<`void`> -*Defined in [lib/DeviceInterface.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L11)* +*Defined in [lib/DeviceInterface.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L11)* **Parameters:** @@ -174,7 +174,7 @@ ___ ▸ **writeByte**(command: *`number`*, byte: *`number`*): `Promise`<`void`> -*Defined in [lib/DeviceInterface.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L17)* +*Defined in [lib/DeviceInterface.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L17)* **Parameters:** @@ -192,7 +192,7 @@ ___ ▸ **writeI2cBlock**(command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/DeviceInterface.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L19)* +*Defined in [lib/DeviceInterface.ts:19](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L19)* **Parameters:** @@ -211,7 +211,7 @@ ___ ▸ **writeWord**(command: *`number`*, word: *`number`*): `Promise`<`void`> -*Defined in [lib/DeviceInterface.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/DeviceInterface.ts#L18)* +*Defined in [lib/DeviceInterface.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/DeviceInterface.ts#L18)* **Parameters:** diff --git a/docs/interfaces/i2cbuspromised.md b/docs/interfaces/i2cbuspromised.md index 49d5931..109b5ac 100644 --- a/docs/interfaces/i2cbuspromised.md +++ b/docs/interfaces/i2cbuspromised.md @@ -85,7 +85,7 @@ ___ ▸ **closeAsync**(): `Promise`<`void`> -*Defined in [lib/types.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L5)* +*Defined in [lib/types.ts:5](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L5)* **Returns:** `Promise`<`void`> @@ -132,7 +132,7 @@ ___ ▸ **i2cFuncsAsync**(): `Promise`<`I2cBusFuncs`> -*Defined in [lib/types.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L7)* +*Defined in [lib/types.ts:7](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L7)* **Returns:** `Promise`<`I2cBusFuncs`> @@ -184,7 +184,7 @@ ___ ▸ **i2cReadAsync**(address: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/types.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L10)* +*Defined in [lib/types.ts:10](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L10)* **Parameters:** @@ -252,7 +252,7 @@ ___ ▸ **i2cWriteAsync**(address: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/types.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L11)* +*Defined in [lib/types.ts:11](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L11)* **Parameters:** @@ -319,7 +319,7 @@ ___ ▸ **readByteAsync**(address: *`number`*, command: *`number`*): `Promise`<`number`> -*Defined in [lib/types.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L16)* +*Defined in [lib/types.ts:16](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L16)* **Parameters:** @@ -386,7 +386,7 @@ ___ ▸ **readI2cBlockAsync**(address: *`number`*, command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/types.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L18)* +*Defined in [lib/types.ts:18](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L18)* **Parameters:** @@ -455,7 +455,7 @@ ___ ▸ **readWordAsync**(address: *`number`*, command: *`number`*): `Promise`<`number`> -*Defined in [lib/types.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L17)* +*Defined in [lib/types.ts:17](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L17)* **Parameters:** @@ -519,7 +519,7 @@ ___ ▸ **receiveByteAsync**(address: *`number`*): `Promise`<`number`> -*Defined in [lib/types.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L13)* +*Defined in [lib/types.ts:13](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L13)* **Parameters:** @@ -580,7 +580,7 @@ ___ ▸ **scanAsync**(): `Promise`<`number`[]> -*Defined in [lib/types.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L8)* +*Defined in [lib/types.ts:8](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L8)* **Returns:** `Promise`<`number`[]> @@ -631,7 +631,7 @@ ___ ▸ **sendByteAsync**(address: *`number`*, byte: *`number`*): `Promise`<`void`> -*Defined in [lib/types.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L14)* +*Defined in [lib/types.ts:14](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L14)* **Parameters:** @@ -695,7 +695,7 @@ ___ ▸ **writeByteAsync**(address: *`number`*, command: *`number`*, byte: *`number`*): `Promise`<`void`> -*Defined in [lib/types.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L20)* +*Defined in [lib/types.ts:20](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L20)* **Parameters:** @@ -762,7 +762,7 @@ ___ ▸ **writeI2cBlockAsync**(address: *`number`*, command: *`number`*, length: *`number`*, buffer: *`Buffer`*): `Promise`<`number`> -*Defined in [lib/types.ts:22](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L22)* +*Defined in [lib/types.ts:22](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L22)* **Parameters:** @@ -879,7 +879,7 @@ ___ ▸ **writeWordAsync**(address: *`number`*, command: *`number`*, word: *`number`*): `Promise`<`void`> -*Defined in [lib/types.ts:21](https://github.com/AlejandroHerr/async-i2c-bus/blob/d8a1788/src/lib/types.ts#L21)* +*Defined in [lib/types.ts:21](https://github.com/AlejandroHerr/async-i2c-bus/blob/d6f8f27/src/lib/types.ts#L21)* **Parameters:**