obniz/parts/ADConverter/hx711/README.md

obniz sdk for javascript

# HX711

24-bit ADC designed for weigh scales.


## wired(obniz, {vcc, gnd, sck, dout})

Vcc and gnd is optinal if you supply it another way.

```javascript
var sensor = obniz.wired("hx711" , {gnd:0, dout:1, sck:2, vcc:3} );
```

## [await]  getValueWait(times = 1)
Get a value which is calculated with offset, scale.
Set times param if you want use average. 

```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:0, dout:1, sck:2, vcc:3} );
var value = await sensor.getValueWait(10); //10 times average
console.log('grams:' + value);
```


## offset

```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:0, dout:1, sck:2, vcc:3} );
sensor.offset = 7000;
sensor.scale = 2280;
var value = await sensor.getValueWait(10); //10 times average
console.log('grams:' + value);
```

## zeroAdjust(times = 1)
Set offset with current value. 
```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:0, dout:1, sck:2, vcc:3} );
sensor.zeroAdjust();
sensor.scale = 2280;
var value = await sensor.getValueWait(10); //10 times average
console.log('grams:' + value);
```


## scale

```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:0, dout:1, sck:2, vcc:3} );
sensor.zeroAdjust();
sensor.scale = 2280;
var value = await sensor.getValueWait(10); //10 times average
console.log('grams:' + value);
```

## powerDown
Into sleep Mode.
```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:1, dout:1, sck:2, vcc:3} );

sensor.powerDown();
sensor.powerUp();
```


## powerUp
Wake up from sleep Mode.
```javascript
// Javascript Example
var sensor = obniz.wired("hx711" , {gnd:1, dout:1, sck:2, vcc:3} );
sensor.powerDown();
sensor.powerUp();
```