wire_helper.ino File Reference

@license MIT License More...

#include <SPI.h>
#include <SensorWireHelper.h>
#include <Commander.h>

Include dependency graph for wire_helper.ino:

Go to the source code of this file.

Macros
#define	SerialMon   Serial
#define	SENSOR_SDA   2
#define	SENSOR_SCL   3

Functions
bool	dumpReg (Commander &Cmdr)
bool	dumpDevices (Commander &Cmdr)
bool	helpHandler (Commander &Cmdr)
void	setup ()
void	loop ()
uint8_t	toInt (String data)

Variables
Commander	cmd
const commandList_t	masterCommands []

Detailed Description

@license MIT License

Copyright (c) 2025 lewis he

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Lewis He (lewis.nosp@m.he@o.nosp@m.utloo.nosp@m.k.co.nosp@m.m)

Date

2025-01-15

Definition in file wire_helper.ino.

Macro Definition Documentation

SENSOR_SCL

#define SENSOR_SCL   3

Definition at line 43 of file wire_helper.ino.

SENSOR_SDA

#define SENSOR_SDA   2

Definition at line 39 of file wire_helper.ino.

SerialMon

#define SerialMon   Serial

Definition at line 35 of file wire_helper.ino.

Function Documentation

dumpDevices()

bool dumpDevices

(

Commander &

Cmdr

)

Definition at line 155 of file wire_helper.ino.

References SerialMon.

dumpReg()

bool dumpReg

(

Commander &

Cmdr

)

Definition at line 114 of file wire_helper.ino.

References SerialMon, and toInt().

helpHandler()

bool helpHandler

(

Commander &

Cmdr

)

Definition at line 60 of file wire_helper.ino.

References SerialMon.

loop()

void loop

(

)

Definition at line 97 of file wire_helper.ino.

References cmd.

setup()

void setup

(

)

Definition at line 68 of file wire_helper.ino.

References cmd, masterCommands, SENSOR_SCL, SENSOR_SDA, and SerialMon.

toInt()

uint8_t toInt

(

String

data

)

Definition at line 103 of file wire_helper.ino.

Referenced by dumpReg().

Variable Documentation

cmd

Commander cmd

Definition at line 46 of file wire_helper.ino.

Referenced by loop(), and setup().

masterCommands

const commandList_t masterCommands[]

Initial value:

= {
    {"help",     helpHandler, "help"},
    {"dump reg", dumpReg, "dump reg"},
    {"dump devices", dumpDevices, "dump devices"},
 
}

Definition at line 53 of file wire_helper.ino.

Referenced by setup().