# meter モジュール 

| 状態 |前回更新時間 | APIヴァージョン |
| ------ | ------ | ------ |
| Active | 2019-11-14 | V1.00.00 |

## 説明
オンボード電流電圧計をアクセスする。
 
## meter.setDataSource()
### 説明
読み取り值の情報元を設定する。

### パラメータ

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| <dataSource> | number| meter.INSTANT meter.FILTERSTAGE1 meter.FILTERSTAGE2 |情報元|

- `meter.INSTANT`: 瞬間情報元, リフレッシュ周期は１ミリ秒。
- `meter.FILTERSTAGE1` :　情報元をFILTERSTAGE1にする、読み取り值は`meter.INSTANT`の平均した值です。平均の周期はユーザーの設定で決定されます、一般的な画面表示で使用をお勧めします。
- `meter.FILTERSTAGE2` : 情報元をFILTERSTAGE2にする、この值は、FILTERSTAGE1に基づいてフィルターした值です。 安定な画面表示で使用をお勧めします。

もし画面表示のためではなく、`meter.INSTANT`に情報元を設定することはお勧めです、この情報元が速くて精密な值を供給します。`meter.FILTERSTAGE1`と`meter.FILTERSTAGE2`の更新の速さがユーザーの設定で決定されます

### 戻り値
nil
### 呼び出す例
```lua
meter.setDataSource(meter.INSTANT)
```

## meter.readVoltage()
### 説明
電圧をボルトで読みます。

### パラメータ
nil
### 戻り値

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| voltage | number| 0~36 |電圧|

### 呼び出す例
```lua
voltage = meter.readVoltage()
```

## meter.readCurrent()
### 説明
電流をアンプで読みます。
画面表示の便利性のため、戻り値は絶対値にしました。電流方向をゲットすれば、`meter.readCurrentDirection()`を呼び出し下さい。

### パラメータ
nil
### 返回值

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| current | number| 0~6 |電流|

### 呼び出す例
```lua
current = meter.readCurrent()
```

## meter.readPower()
###  説明
電力をワットで読みます。
画面表示の便利性のため、戻り値は絶対値にしました。

### パラメータ
nil
### 戻り値

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| power | number| 0~6 |電力|

### 呼び出す例
```lua
power = meter.readPower()
```
## meter.readDP()
### 説明
ＤＰ電圧をボルトで読みます。

### パラメータ
nil
### 戻り値

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| v_dp | number| 0~3.3 |DP電圧|

### 呼び出す例
```lua
dp = meter.readDP()
```

## meter.readDM()
### 説明
ＤＭ電圧をボルトで読みます。

### パラメータ
nil
### 戻り値

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| v_dm | number| 0~3.3 |DP电压读数|

### 呼び出す例
```lua
dp = meter.readDM()
```
## meter.readCurrentDirection()
### 説明
電流方向を読みます。電流が逆だったら、戻り値がtrueになります。

### パラメータ
nil
### 戻り値

| 名前 | タイプ | 範囲 | 用途 |
| ------ | ------ | ------ |  ------ |
| dir | boolean|  |方向|

### 呼び出す例
```lua
dir = meter.readCurrentDirection()
```