InternetPlat built off of SSLClient running over an Ethernet Featherwing. More...

#include <InternetEthernet.h>

Inheritance diagram for Loom_Ethernet:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Ethernet (LoomManager manager, const char module_name="Ethernet", const JsonArrayConst mac=JsonArray(), const JsonArrayConst ip=JsonArray())
	Constructor. More...

	Loom_Ethernet (LoomManager *manager, JsonArrayConst p)
	Constructor that takes Json Array, extracts args and delegates to regular constructor. More...

virtual	~Loom_Ethernet ()=default
	Destructor. More...

OPERATION
void	connect () override
	Connect to internet. More...

bool	is_connected () const override
	Whether or not connected to internet. More...

UDPPtr	open_socket (const uint port) override
	Open a UDP socket for sending and recieving incoming data. More...

PRINT INFORMATION
void	print_config () const override
	Display the configuration settings of the module. More...

void	print_state () const override
	Display current state of the module. More...

Public Member Functions inherited from LoomInternetPlat
	LoomInternetPlat (LoomManager manager, const char module_name, const LoomModule::Type module_type)
	Loom Internet Platform module constructor. More...

virtual	~LoomInternetPlat ()=default
	Destructor. More...

virtual void	package (JsonObject json) override
	No package necessary for internet platforms. More...

virtual ClientSession	http_request (const char domain, const char url, const char body, const char verb)
	Make HTTP request. More...

ClientSession	http_get_request (const char domain, const char url, const char *body=nullptr)
	Make HTTP GET request. More...

ClientSession	http_post_request (const char domain, const char url, const char *body=nullptr)
	Make HTTP POST request. More...

virtual ClientSession	connect_to_domain (const char *domain)
	Connect to a domain, but don't write any HTTP stuff, Let the module figure that out. More...

virtual ClientSession	connect_to_ip (const IPAddress &ip, const uint16_t port)
	Connect to a domain, but don't write any HTTP stuff, Let the module figure that out. More...

virtual void	disconnect ()

uint32_t	get_time ()
	make NTP request to get UTC time, using the UDP function above More...

Public Member Functions inherited from LoomModule
	LoomModule (LoomManager manager, const char module_name="Unknown", const Type module_type=Type::Unknown)
	Constructor. More...

virtual	~LoomModule ()=default
	Destructor. More...

virtual void	second_stage_ctor ()
	Second stage construction. More...

virtual bool	dispatch (JsonObject json)
	Route command to driver. More...

virtual void	power_down ()
	Turn off any hardware. More...

virtual void	power_up ()
	Turn on any hardware. More...

virtual void	add_config (JsonObject json)
	Add configuration information to JsonObject. More...

Type	get_module_type () const
	Get module type. More...

LoomManager *	get_device_manager () const
	Get the device manager class if linked. More...

void	get_module_name (char *buf) const
	Copy module name into buffer. More...

const char *	get_module_name () const
	Get module name. More...

Verbosity	get_print_verbosity () const
	Get print verbosity. More...

Verbosity	get_package_verbosity () const
	Get package verbosity. More...

bool	get_active () const
	Get whether or not the module should be treated as active. More...

Category	category () const
	Get the category of the module. More...

virtual void	link_device_manager (LoomManager *LM)
	Add pointer back to device manager. More...

void	set_print_verbosity (const Verbosity v)
	Set print verbosity Controlls level of detail included in debug prints. More...

void	set_package_verbosity (const Verbosity v)
	Set package verbosity. More...

void	set_active (const bool enable)
	Set whether or not the module should be treated as active. More...

Protected Member Functions
SSLClient &	get_client () override
	Get the underlying SSLClient implementation, which we will use for all of the other requests. More...

const SSLClient &	get_client () const

Protected Member Functions inherited from LoomInternetPlat
void	write_http_request (Stream &client, const char domain, const char url, const char body, const char verb)
	Utility function to write an http reqest based on parameters specified by LoomInternetPlat::http_request to a Client class. More...

Protected Member Functions inherited from LoomModule
void	print_module_label () const
	Print the module name as a label. More...

Protected Attributes
EthernetClient	m_base_client

SSLClient	m_client
	Underlying Ethernet SSLclient instance. More...

byte	m_mac [6]
	The Ethernet MAC address. More...

IPAddress	m_ip
	The devices IP address. More...

bool	m_is_connected
	Whether or not ethernet initialized successfully. More...

Protected Attributes inherited from LoomModule
const Type	module_type
	Module type. More...

LoomManager *	device_manager
	Pointer to manager. More...

const String	module_name_base
	The name of the module (Should have a DEFAULT but can be overriden if provided to constructor) More...

const char *	module_name

bool	active
	Whether or not the module should be treated as active. More...

Verbosity	print_verbosity
	Print verbosity. More...

Verbosity	package_verbosity
	Package verbosity. More...

Additional Inherited Members
Public Types inherited from LoomInternetPlat
using	UDPPtr = std::unique_ptr< UDP, UDPDeletor >
	Cleaner name for UDP smart pointer. More...

using	ClientSession = std::unique_ptr< Client, ClientCleanup >
	Cleaner name for Client smart pointer. More...

Public Types inherited from LoomModule
enum	Type { Type::Unknown = 0, Type::Other =1000, Type::Interrupt_Manager, Type::Sleep_Manager, Type::Multiplexer, Type::NTP, Type::TempSync, Type::WarmUp_Manager, Type::Sensor =2000, Type::Analog, Type::Digital, Type::I2C =2100, Type::ADS1115, Type::AS7262, Type::AS7263, Type::AS7265X, Type::FXAS21002, Type::FXOS8700, Type::LIS3DH, Type::MB1232, Type::MMA8451, Type::MPU6050, Type::MS5803, Type::SHT31D, Type::TMP007, Type::TSL2561, Type::TSL2591, Type::ZXGesture, Type::STEMMA, Type::SDI12 =2200, Type::Decagon5TM, Type::DecagonGS3, Type::SPI =2300, Type::MAX31855, Type::MAX31856, Type::L_SERIAL =2400, Type::K30, Type::L_RTC =3000, Type::DS3231, Type::PCF8523, Type::Actuator =4000, Type::Neopixel, Type::Relay, Type::Servo, Type::Stepper, Type::LogPlat =5000, Type::OLED, Type::SDCARD, Type::BATCHSD, Type::CommPlat =6000, Type::LoRa, Type::nRF, Type::Bluetooth, Type::InternetPlat =7000, Type::Ethernet, Type::WiFi, Type::LTE, Type::PublishPlat =8000, Type::GoogleSheets, Type::MaxPub, Type::SpoolPub, Type::SubscribePlats =9000, Type::MaxSub }
	Enum to check against to when finding individual component managed by a LoomManager. More...

enum	Category { Category::Unknown =0, Category::Other =1, Category::Sensor =2, Category::L_RTC =3, Category::Actuator =4, Category::LogPlat =5, Category::CommPlat =6, Category::InternetPlat =7, Category::PublishPlat =8, Category::SubscribePlat =9 }
	Enum to classify modules. More...

Static Public Member Functions inherited from LoomModule
static const char *	enum_verbosity_string (const Verbosity v)
	Get string of name associated with verbosity enum. More...

static const char *	enum_category_string (const Category c)
	Get string of the category associated with a Category. More...

Detailed Description

InternetPlat built off of SSLClient running over an Ethernet Featherwing.

Attention: Requires 7KB of free SRAM at runtime to use.

Resources

Module Documentation
Product Page: Adafruit Ethernet Featherwing
Dependency: EthernetLarge OPEbS Lab fork of Arduino Ethernet library
Dependency: SSLClient
Hardware Support

Constructor & Destructor Documentation

Loom_Ethernet::Loom_Ethernet	(	LoomManager *	manager,
		const char *	module_name = `"Ethernet"`,
		const JsonArrayConst	mac = `JsonArray()`,
		const JsonArrayConst	ip = `JsonArray()`
	)

Constructor.

Loom_Ethernet::Loom_Ethernet	(	LoomManager *	manager,
		JsonArrayConst	p
	)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters

[in] p The array of constuctor args to expand

virtual Loom_Ethernet::~Loom_Ethernet ( )

virtualdefault

Destructor.

Member Function Documentation

void Loom_Ethernet::connect ( )

overridevirtual

Connect to internet.

Implements LoomInternetPlat.

SSLClient& Loom_Ethernet::get_client ( )

inlineoverrideprotectedvirtual

Get the underlying SSLClient implementation, which we will use for all of the other requests.

Implements LoomInternetPlat.

const SSLClient& Loom_Ethernet::get_client ( ) const

inlineprotectedvirtual

Implements LoomInternetPlat.

bool Loom_Ethernet::is_connected ( ) const

inlineoverridevirtual

Whether or not connected to internet.

Returns: True if connect, false otherwise

Implements LoomInternetPlat.

LoomInternetPlat::UDPPtr Loom_Ethernet::open_socket ( const uint port )

overridevirtual

Open a UDP socket for sending and recieving incoming data.

Warning: Be careful about recieving data from an open socket!

Parameters

[in] port Port to open socket with

Returns: A UDP socket for transmitting and recieving, remember to close the socket when you are done!

Implements LoomInternetPlat.

void Loom_Ethernet::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

void Loom_Ethernet::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

Member Data Documentation

EthernetClient Loom_Ethernet::m_base_client

protected

SSLClient Loom_Ethernet::m_client

protected

Underlying Ethernet SSLclient instance.

IPAddress Loom_Ethernet::m_ip

protected

The devices IP address.

bool Loom_Ethernet::m_is_connected

protected

Whether or not ethernet initialized successfully.

byte Loom_Ethernet::m_mac[6]

protected

The Ethernet MAC address.

The documentation for this class was generated from the following files:

src/InternetPlats/InternetEthernet.h
src/InternetPlats/InternetEthernet.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation