var searchIndex = {};
searchIndex["socketcan"] = {"doc":"socketCAN support.","items":[[3,"CANSocket","socketcan","A socket for a CAN device.",null,null],[3,"CANFrame","","CANFrame",null,null],[4,"CANSocketOpenError","","Errors opening socket",null,null],[13,"LookupError","","Device could not be found",0,null],[13,"IOError","","System error while trying to look up device name",0,null],[4,"ConstructionError","","Error that occurs when creating CAN packets",null,null],[13,"IDTooLarge","","CAN ID was outside the range of valid IDs",1,null],[13,"TooMuchData","","More than 8 Bytes of payload data were passed in",1,null],[17,"EFF_FLAG","","if set, indicate 29 bit extended format",null,null],[17,"RTR_FLAG","","remote transmission request flag",null,null],[17,"ERR_FLAG","","error flag",null,null],[17,"SFF_MASK","","valid bits in standard frame id",null,null],[17,"EFF_MASK","","valid bits in extended frame id",null,null],[17,"ERR_MASK","","valid bits in error frame",null,null],[8,"ShouldRetry","","Check an error return value for timeouts.",null,null],[10,"should_retry","","Check for timeout",2,null],[11,"fmt","","",0,null],[11,"fmt","","",0,null],[11,"description","","",0,null],[11,"cause","","",0,null],[11,"clone","","",1,null],[11,"fmt","","",1,null],[11,"fmt","","",1,null],[11,"description","","",1,null],[11,"from","","",0,{"inputs":[{"name":"error"}],"output":{"name":"cansocketopenerror"}}],[11,"from","","",0,{"inputs":[{"name":"error"}],"output":{"name":"cansocketopenerror"}}],[11,"open","","Open a named CAN device.",3,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"open_if","","Open CAN device by interface number.",3,{"inputs":[{"name":"c_uint"}],"output":{"name":"result"}}],[11,"set_read_timeout","","Sets the read timeout on the socket",3,null],[11,"set_write_timeout","","Sets the write timeout on the socket",3,null],[11,"read_frame","","Blocking read a single can frame.",3,null],[11,"write_frame","","Blocking write a single can frame.",3,null],[11,"drop","","",3,null],[11,"clone","","",4,null],[11,"fmt","","",4,null],[11,"new","","",4,null],[11,"id","","Return the actual CAN ID (without EFF/RTR/ERR flags)",4,null],[11,"err","","Return the error message",4,null],[11,"is_extended","","Check if frame uses 29 bit extended frame format",4,null],[11,"is_error","","Check if frame is an error message",4,null],[11,"is_rtr","","Check if frame is a remote transmission request",4,null],[11,"data","","A slice into the actual data. Slice will always be <= 8 bytes in length",4,null],[11,"fmt","","",4,null]],"paths":[[4,"CANSocketOpenError"],[4,"ConstructionError"],[8,"ShouldRetry"],[3,"CANSocket"],[3,"CANFrame"]]};
initSearch(searchIndex);