File Coverage

blib/lib/Device/Chip/MAX1166x.pm

Criterion	Covered	Total	%
statement	29	38	76.3
branch			n/a
condition			n/a
subroutine	8	10	80.0
pod	2	5	40.0
total	39	53	73.5

#  You may distribute under the terms of either the GNU General Public License
#  or the Artistic License (the same terms as Perl itself)
#
#  (C) Paul Evans, 2020-2023 -- [e-mail]

use v5.26;
use warnings;
use Object::Pad 0.800;

package Device::Chip::MAX1166x 0.15;
class Device::Chip::MAX1166x
   :isa(Device::Chip);

use Future::AsyncAwait;

use constant PROTOCOL => "SPI";

=head1 NAME

C - chip driver for F family

=head1 SYNOPSIS

   use Device::Chip::MAX1166x;
   use Future::AsyncAwait;

   my $chip = Device::Chip::MAX1166x->new;
   await $chip->mount( Device::Chip::Adapter::...->new );

   printf "The reading is %d\n", await $chip->read_adc;

=head1 DESCRIPTION

This L subclass provides specific communications to a chip in
the F F family, such as F, F or
F.

The reader is presumed to be familiar with the general operation of this chip;
the documentation here will not attempt to explain or define chip-specific
concepts or features, only the use of this module to access them.

=cut

sub SPI_options ( $, %params )
{
   return (
      mode        => 2,
      max_bitrate => 8E6,
   );
}

=head1 METHODS

The following methods documented in an C expression return L
instances.

=cut

# Chip has no config registers
async method read_config () { return {} }
async method change_config (%) { }

=head2 read_adc

   $value = await $chip->read_adc;

Performs a conversion and returns the result as a plain unsigned 12-bit
integer.

=cut

async method read_adc ()
{
   my $buf = await $self->protocol->read( 2 );

   return unpack "S>", $buf;
}

=head2 read_adc_ratio

   $ratio = await $chip->read_adc_ratio;

Performs a conversion and returns the result as a floating-point number
between 0 and 1.

=cut

async method read_adc_ratio ()
{
   # MAX1166x reads as 14-bit with some trailing zeroes
   # First bit is invalid so must mask it off
   return ( ( await $self->read_adc ) & 0x7FFF ) / 2**14;
}

=head1 AUTHOR

Paul Evans

=cut

0x55AA;