village village village
  • Documentation
  • API
  • Resources
  • FAQ
/
  • DOCUMENTATION
    • SYSTEM OVERVIEW
      • Detailed System Description
      • System Requirements
    • PREPARATION & SETUP
      • Initial Setup
      • Launching the TV Application
      • Remote Access Configuration
      • Telegram Bot Integration
      • Data Persistence & Backups
      • Remote Heartbeat Monitoring
      • Animal Handling
    • SYSTEM OPERATION
      • GUI Overview
      • System Settings
      • Subject Management
      • Manual Task Execution
      • Corridor Calibration
      • Animal Detection & Tracking
      • Toolbar Controls
      • Sound Integration
      • Screen Integration
      • LED Strip
      • Saved Data and Video
      • Timing, Clocks & Latencies
      • System Logic (State Machine)
    • PROTOCOL & TASK DESIGN
      • Protocol Creation
      • Task Development Guide
      • Direct, Audio & Video Functions
      • Custom Camera Interaction
      • Custom Touchscreen Interaction
      • Custom Plotting
      • Custom Scheduled Actions
      • Custom Calibrations
      • Custom AutoNoMouse
    • MAINTENANCE & TROUBLESHOOTING
      • Cleaning & Routine Maintenance
      • Alarm System Overview
      • Troubleshooting Guide
  • API
    • calibration
      • bpod_water_calibration
      • camera_calibration
      • camera_calibration_grid
        • make_circle_grid
      • optogrid_calibration
        • OptoGridCalibration
      • sound_calibration
    • classes
      • calibrations
        • Calibrations
      • collection
        • convert_active
        • Collection
      • enums
        • Actions
        • Active
        • AreaActive
        • Color
        • ControllerEnum
        • Cycle
        • DataTable
        • Info
        • OldVersion
        • PixelType
        • Save
        • ScreenActive
        • State
        • SuperEnum
        • SyncType
      • null_classes
        • NullBpod
        • NullCalibrationBase
        • NullCamera
        • NullChip
        • NullCollection
        • NullLEDStrip
        • NullMotor
        • NullScale
        • NullSoftCodeToBpod
        • NullSoundDevice
        • NullStateMachine
        • NullTelegramBot
        • NullTempSensor
        • NullTouch
      • settings_class
        • Setting
        • Settings
      • subject
        • Subject
    • custom_classes
      • after_session_base
        • AfterSessionBase
      • auto_no_mouse_base
        • AutoNoMouseBase
        • AutonomouseParam
      • calibration_base
      • camera_draw_base
        • CameraDrawBase
      • camera_trigger_base
        • CameraTriggerBase
      • change_cycle_base
        • ChangeCycleBase
      • direct_functions_base
        • DirectFunctionsBase
      • online_plot_base
        • OnlinePlotBase
      • session_plot_base
        • SessionPlotBase
      • subject_plot_base
        • SubjectPlotBase
      • task_base
        • BpodEvent
        • BpodOutput
        • TaskBase
        • village.custom_classes.task_base.TaskError
      • touch_trigger_base
        • TouchTriggerBase
      • training_protocol_base
        • Settings
        • TrainingProtocolBase
        • village.custom_classes.training_protocol_base.TrainingError
    • devices
      • camera
      • chip
        • get_motor
        • get_motor_old
        • LED
        • Motor
      • led_strip
      • motor_old
        • find_pwmchip
        • MotorOld
      • optogrid
        • export_csv
        • og_connect
        • IMUConfig
        • OptoGrid
        • OptoSetting
      • rfid
      • scale
        • get_scale
        • Scale
      • screen
      • sound_device
        • get_sound_device
        • get_sound_devices
        • SoundDevice
      • telegram_bot
      • temp_sensor
        • get_temp_sensor
        • TempSensor
      • touch
        • get_touch
        • Touch
    • gui
      • calibration_layout
      • camera_calibration_layout
        • CameraCalibrationLayout
        • DiagnosticPlotsLayout
      • data_layout
      • gui
      • gui_window
      • layout
      • main_layout
      • monitor_layout
      • settings_layout
      • tasks_layout
    • plots
      • corridor_plot
        • corridor_plot
      • temperatures_plot
        • temperatures_plot
      • weights_plot
        • weights_plot
    • scripts
      • error_queue
      • global_csv_for_subject
        • main
      • import_all
      • log
        • Log
      • parse_bpod_messages
        • parse_input_to_tuple_override
        • parse_output_to_tuple
        • parse_output_to_tuple_override
      • playground
        • measure_softcode_latency
        • BpodWithLatencyTest
      • rsync_to_hard_drive
        • main
        • run_rsync_local
      • rsync_to_server
        • main
        • run_rsync
      • safe_removal_of_data
        • check_files_for_backup_local
        • check_files_for_backup_remote
        • main
        • parse_timestamp_from_filename
        • remove_file
        • remove_old_data
      • time_utils
        • TimeUtils
      • utils
        • active_last_24_hours
        • change_directory_settings
        • change_system_directory_settings
        • create_directories
        • create_directories_from_path
        • create_pixmap
        • delete_all_elements_from_layout
        • download_github_repositories
        • get_x_value_interp
        • has_low_disk_space
        • interpolate
        • is_active
        • is_active_regular
        • reformat_trial_data
        • setup_logging
        • transform_raw_to_clean
        • validate_subject_name
    • manager
    • main
  • RESOURCES
    • HARDWARE RESOURCES
      • List of Parts & Design Files
      • Assembly Guide
      • Assembly Guide (with Eco-HAB)
      • Assembly Guide (Rat Version)
    • SOFTWARE RESOURCES
      • Manual Software Installation
      • Disk Image
  • FAQ
    • FAQ
      • Frequently Asked Questions
  1. village /
  2. API /
  3. classes /
  4. enums
View Source Open in ChatGPT Open in Claude

enums

Classes

Actions(value)

Active(value)

AreaActive(value)

Color(value)

ControllerEnum(value)

Cycle(value)

DataTable(value)

Info(value)

OldVersion(value)

PixelType(value)

Save(value)

ScreenActive(value)

State(value)

Enum representing the state of the village system.

SuperEnum(value)

Base Enum class with extended functionality.

SyncType(value)

Previous
Collection
Next
Actions

© Brain Circuits and Behavior Lab

Made with Sphinx and Shibuya theme.

GitHub Contact: braincircuitsbehavior@gmail.com