swc.aeon.schema.environment#

Classes for defining environment configuration models.

class swc.aeon.schema.environment.LightCycle(**data)[source]#

Bases: BaseSchema

Represents a network client for automated room light control.

command_socket: str#
config_file_name: str#
event_socket: str#
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'field_title_generator': <function BaseSchema.<lambda>>, 'from_attributes': True, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) – The BaseModel instance.

  • context (Any) – The context.

Return type:

None

room_name: str#
class swc.aeon.schema.environment.WeightScale(**data)[source]#

Bases: BaseSchema

Represents acquisition functionality for automated habitat weighing scales.

filter_window: int#
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'field_title_generator': <function BaseSchema.<lambda>>, 'from_attributes': True, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) – The BaseModel instance.

  • context (Any) – The context.

Return type:

None

port_name: str#