Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Training village
Logo
  • User Guide
    • Getting Started
    • Animal Procedures
    • GUI Overview
    • Initial Settings
    • Create New Subjects
    • Calibrate and Test Corridor Components
    • Calibrate and Test Animal Detection
    • Use an Existing Training Protocol
    • Create a New Training Protocol
    • Test a Training Protocol
    • Create Real-Time Plots
    • Saved Data
    • System State Machine
    • Receive and Respond to Telegram Alarms
    • Maintenance
  • How to Build It
    • List of Parts
    • Assembly Instructions
    • Software Installation
  • Initial Configuration
    • Hardware Connections
    • Configure Remote Access
    • Create a Telegram Bot
    • Schedule Backups
    • Send Heartbeat Signals to a Remote Device
  • API
    • devices
      • bpod
        • get_bpod
        • PyBpod
        • Softcode
      • scale
        • get_scale
        • Scale
      • temp_sensor
        • get_temp_sensor
        • TempSensor
    • classes
      • collection
        • Collection
      • enums
        • Actions
        • Active
        • AreaActive
        • Color
        • Cycle
        • DataTable
        • Info
        • ScreenActive
        • State
        • SuperEnum
      • protocols
        • CameraProtocol
        • EventProtocol
        • PyBpodProtocol
        • ScaleProtocol
        • TelegramBotProtocol
        • TempSensorProtocol
      • settings_class
        • Setting
        • Settings
      • subject
        • Subject
      • task
        • Event
        • Output
        • Task
        • village.classes.task.TaskError
      • training
        • Settings
        • Training
        • village.classes.training.TrainingError
    • gui
    • pybpodapi
      • bpod
        • Bpod
        • bpod_base
          • BpodBase
        • bpod_com_protocol
          • BpodCOMProtocol
        • bpod_com_protocol_modules
          • BpodCOMProtocolModules
        • bpod_io
          • BpodIO
        • hardware
          • channels
            • ChannelName
            • ChannelType
            • Channels
            • EventsPositions
          • events
            • base_eventname
              • BaseEventName
            • bpod_events
              • EventName
          • hardware
            • Hardware
          • input_channels
            • bpod_input_channels
              • InputName
          • output_channels
            • bpod_output_channels
              • OutputChannel
        • non_blockingsocketreceive
          • NonBlockingSocketReceive
          • village.pybpodapi.bpod.non_blockingsocketreceive.UnexpectedEndOfStream
        • non_blockingstreamreader
          • NonBlockingStreamReader
          • village.pybpodapi.bpod.non_blockingstreamreader.UnexpectedEndOfStream
        • settings
      • bpod_modules
        • bpod_module
          • BpodModule
        • bpod_modules
          • BpodModules
      • com
        • arcom
          • ArCOM
          • ArduinoTypes
          • DataType
        • messaging
          • base_message
            • BaseMessage
          • debug
            • DebugMessage
          • end_trial
            • EndTrial
          • error
            • ErrorMessage
          • event_occurrence
            • EventOccurrence
          • event_resume
            • EventResume
          • parser
            • MessageParser
          • session_info
            • SessionInfo
          • softcode_occurrence
            • SoftcodeOccurrence
          • state_occurrence
            • StateOccurrence
          • state_transition
            • StateTransition
          • stderr
            • StderrMessage
          • stdout
            • StdoutMessage
          • trial
            • Trial
          • untagged_message
            • UntaggedMessage
          • value
            • ValueMessage
          • warning
            • WarningMessage
        • protocol
          • recv_msg_headers
            • ReceiveMessageHeader
          • send_msg_headers
            • SendMessageHeader
        • stderr_buffer
          • StderrBuffer
        • stdout_buffer
          • StdoutBuffer
      • exceptions
        • bpod_error
          • village.pybpodapi.exceptions.bpod_error.BpodErrorException
      • protocol
      • session
        • Session
        • StreamsWrapper
      • state_machine
        • StateMachine
        • conditions
          • Conditions
        • global_counters
          • GlobalCounters
        • global_timers
          • GlobalTimers
        • state_machine_base
          • StateMachineBase
          • village.pybpodapi.state_machine.state_machine_base.SMAError
        • state_machine_builder
          • StateMachineBuilder
          • village.pybpodapi.state_machine.state_machine_builder.StateMachineBuilderError
        • state_machine_runner
          • StateMachineRunner
          • village.pybpodapi.state_machine.state_machine_runner.StateMachineRunnerError
      • utils
        • csv
          • Reader
          • Writer
        • date_parser
          • parse
    • screen
      • behaviour_window
        • BehaviourWindow
    • log
      • Log
    • rt_plots
      • RTPlots
    • time_utils
      • TimeUtils
    • video
      • Example
  • Resources
    • 3D Printing Files
    • System ISO Image
    • Code Repository
  • FAQ
  • Troubleshooting
Back to top
View this page

API

Devices

village.devices

Classes

village.classes

Gui

village.gui

Pybpodapi

village.pybpodapi

Other

village.screen

village.log

village.rt_plots

village.time_utils

village.video

Next
devices
Previous
Send Heartbeat Signals to a Remote Device
Copyright © 2024, Rafael Marin, Balma Serrano, Hernando Vergara
Made with Sphinx and @pradyunsg's Furo
On this page
  • API
    • Devices
    • Classes
    • Gui
    • Pybpodapi
    • Other