x-OSC User Manual - x
Contents
1. 4 OSC User Manual Version 0 4 Preliminary Release ABL h 4 TECHNOLOGIES Copyright 2014 x io Technologies Ltd WWW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 Contents NE uU o rc D Em O O m T 3 el OR NEN HUI IERI Mad bim DM om ne NENNEN MI 4 S FRONDE E ARE TAA E OE ese 5 A A I 5 A NPT CONNECCION ri ne i 6 So UE CO E a EE ETE TT 6 SONIS O E E EA 6 o A A 6 IE nd de et cl en ne Da ot amend 7 A SA 7 5 2 a A un ne dde 7 6 Browser Cont UN II tai 8 6 1 Network Settings 220 DO muere er rrr nr rk nnn rere raa rra aera crias 8 6 2 OSC Settings 5 o DD eene nene nmn tnter r rera 9 6 3 Input Settings RR TT TT TTD e ieueeee emp nen nnn tnr nnno 10 6 4 Output Settings 202 1 1 T DM es eee MR 10 6 5 Serial Settings A 0 A A 12 6 6 IMU Settings A 0000000 DT 12 7 Communicating with x 0 C S9SC Dictiona m 12 7 1 x OSC to host mesSages nn 13 7 2 Host to x OSC message S aore eaae D re 13 WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 1 Document Revision History Date Document Version Description 23 05 2013 0 0 Initial release 06 05 2014 0 4 Compatible with firmware 2 v0 15 WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 2 Overview x OSC is a wireless 1 0 board that provides access to 32 high performance analogue digital channels via2. OSC creates an open Wi Fi network that other devices are able to join By default this network is called x OSC and will show up as an available Wi Fi network in your computer s network settings this network name SSID can be changed in the device settings see section 7 At any time it is always possible to enter ad hock mode by pressing and holding the ping button until the LED begins to flash Cyan 6 2 Infrastructure Mode Yellow LED Infrastructure mode allows x OSC to connect to an existing Wi Fi network Open WPA and WPA2 wireless security modes are supported and x OSC can be configured to have a static IP address or to obtain one dynamically from the network server using DHCP If x OSC is issued an unknown IP address simply press the ping button see section 5 3 which will cause x OSC to broadcast an OSC message indicating its network configuration on its outgoing port 8000 by default Alternatively another network device can broadcast a ping OSC message to achieve the same result Infrastructure mode enables multiple x OSC s to operate on the same network and to be addressed by one or more host computers also connected to the network WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 en E osc Settings me gt C 169 254 1 1 c4 0SC Network OSC gt Inputs gt Outputs gt Serial gt IMU Copyright 2013 x io Technologies x OSC can be configured over
3. gt sets the input channel 1 16 to analogue mode inputs mode digital channel sets the input channel 1 16 to digital mode inputs mode serial channel sets the input channel 1 16 to serial mode inputs analogue read prompts x OSC to respond with an inputs analogue WWVW X io co uk inputs analogue rate inputs analogue comparator read inputs analogue comparator J chresholay lt channel gt yaoi Sy clave tester inputs digital up lt channel gt inputs digital down lt channel gt outputs mode digital lt channel gt outputs mode pulse lt channel gt outputs mode pwm channel outputs mode serial channel outputs digital channel lebimovies digital pattern outputs pulse channel outputs pulse width lt channel gt outputs pulse invert lt channel gt outputs pwm frequency lt channel gt outputs pwm duty lt channel gt outputs rgb lt channel gt outputs serial lt channel gt WWW x i0 co uk x OSC User Manual v0 4 Release date 14 May 2014 message floating point argument sets the message rate for the analogue input readings 0 0 400 0 prompts x OSC to respond with an inputs analogue compare message floating point argument sets the comparator threshold 0 0 1 0 for the specified input channel 1 16 prompts x OSC to respond with an inputs digital message enables the pull up resistor for the
4. specified digital input channel 1 16 enables the pull down resistor for the specified digital input channel 1 16 the specified output channel 1 16 is set to digital mode the specified output channel 1 16 is set to pulse mode the specified output channel 1 16 is set to PWM mode the specified output channel 1 16 is set to serial mode integer argument 0 or 1 sets the state of the specified output channel the lower 16 bits of the integer argument sets the state of all 16 digital outputs triggers a pulse on the specified output channel 1 16 is set to pulse mode Uses the last width and invert values integer argument sets the pulse duration in milliseconds 0 60000 for the specified channel Also triggers a pulse integer argument 0 or 1 sets the inversion state of the pulse 1 is inverted Also triggers a pulse floating point argument sets the PWM frequency 5 250 000 for the specified output channel 1 16 Also sets the pin to PWM mode if not already floating point argument sets the PWM duty cycle 0 100 96 for the specified output channel 1 16 Also sets the pin to PWM mode if not already blob argument will set the RGB values of LEDs connected to channel 1 16 The blob should contain bytes in the format R4 Op Ba R G B5 sa Rn Gn Des blob argument will be transmitted on the specified ser
5. Open Sound Control OSC over Wi Fi There is no requirement for user programmable firmware nor specific drivers making x OSC immediately compatible with any Wi Fi enabled platform All you need is a Wi Fi enabled computer some basic programming skills and you are ready to make sophisticated interactive systems 3 Open Sound Control OSC x OSC communications take place over Wi Fi using the widely supported OSC message format which is a versatile and lightweight protocol supported by more than 80 different programming languages and software environments For an extensive list see http opensoundcontrol org implementations We are also maintaining a growing range of x OSC example projects for the most popular platforms environments here http x io co uk x osc ZN DWA Inputs miren Oo O ak WD QOOOGOQOQOQO O 0220009900 O WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 4 Features Inputs Outputs e 16x analogue digital inputs e 16x digital pulse PWM RGB outputs upto 50 mA per channel e 13 bit ADC with 400 Hz update rate per channel e Up to 16 bit PWM resolution for 5 Hz to 250 kHz e Control up to 400 RGB LEDs NeoPixel e 4X serial communication channels On board sensors e Gyroscope 2000 s accelerometer 16 g and magnetometer e 400 Hz update rate Wi Fi e High performance Wi Fi 802 11b g 54 Mbps e Supports ad hoc and infrastructure networks e Fully configura
6. Serial Channel 3 serial settings below Input 4 Serial Channel 4 serial settings below Input 5 Analogue oo RR Input 6 Analogue Comparator threshold Input 7 Analogue Comparator threshold Input 8 Analogue os Comparator threshold Input 9 Analogue 0 8 Comparator threshold Input 10 Analogue Comparator threshold Input 11 Pull down Pull up Input 12 Pull down Pull up Input 13 Pull down Pull up Input 14 Pull down Pull up Input 15 O Pull down O Pull up Input 16 O Pull down O Pull up Y Outputs Output 1 Serial Channel 1 serial settings below Output 2 Serial Channel 2 serial settings below Output 3 Serial Channel 3 serial settings below Output 4 Serial Channel 4 serial settings below Output 5 Low High Output 6 Low High Output 7 Low High Output 8 Low High Output 9 ms 8 Invert Output 10 100 ms Invert Output 11 ms Invert Output 12 ms Invert Output 13 1 0 Hz 500 Output 14 100 0 sr 50 0 Output 15 Output 16 1000 0 FAR 50 0 10000 0 ESF 25 0 WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 7 5 Serial Settings The serial settings are where the four UARTs connected on input and output channels 1 to 4 may be configured Each channel supports baud rates up to 2 Mbps with 8 data bits no parity and 1 stop bit Serial data can be framed by specifying a buffer size up to 2048 bytes data
7. Wi Fi using an internet browser Simply open your preferred browser and in the address bar type in x OSC s IP address If x OSC is in ad hock mode and you are connected to its network this will be If x OSC is in infrastructure mode you can obtain the IP address by pressing the ping button and listening for an OSC message on x OSC s outgoing port number 8000 by default If at any time you are unable to connect to x OSC simply press and hold the ping button for three seconds to return the device to ad hock mode with an open network you can then access the settings page by joining its network and navigating to The remainder of this section will briefly explain x OSC s browser settings page Note that changes made to any of these settings are only applied when the Save Settings button is pressed In the Network section x OSC can be switched between ad hock and infrastructure modes see section 6 In ad hock mode cyan LED the network name SSID and channel of the x OSC hosted Wi Fi network can be set WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 y Network Network type Ad hoc Infrastructure SSID Channel In infrastructure mode you can enter the name of the network SSID that you would like x OSC to join setting the security mode accordingly Y Network Network type Ad hoc Infrastructure SSID My Network Security Passphrase Use DHCP IP address Subnet mask G
8. ateway Security types Open and WPA WPA2 are supported where the latter option requires entry of a security passphrase In this section you can disable DHCP if you would like to specify a static IP address for x OSC When you are happy that you have entered the correct infrastructure settings click the Save Settings button to reboot x OSC with the new settings The LED will then flash yellow until it has successfully joined the network when it will shine constantly Connection should take approximately 30 seconds if flashing continues for more than one minute then review the infrastructure settings for errors by pressing and holding the ping button for 3 seconds to revert back to ad hock mode see section 6 above In the OSC section the IP and port settings for the receipt and delivery of OSC messages may be configured The host IP is the address to which x OSC will send messages The default IP address is 255 255 255 255 which is a special broadcast address meaning that every device on the network will receive the messages The outgoing port specifies the port on which your computer should listen for messages from x OSC and the incoming port specifies the port on which your computer should send messages to x OSC The local IP shows x OSC s current IP address in a read only field There are two further options in this section When the Send bundles option is checked x OSC will send messages formatted as OSC bundles where the bundle time tag
9. ble via standard internet browser e Small form factor 45 x 32 mm e Regulated 3 3V 700 mA output e Battery level monitor 5 Hardware O18 YN 810 218 BOSC 18 aaa O5 50 S70 go Ll ee dos C CS O 10 E 100 OT 10O O 12 120 O 13 130 SEDO BS eu oS 160 3 3V Out Batt 5 cruna TH E Z Figure 1 x OSC top view 16 analogue digital inputs 16 digital outputs inc high speed PWM for analogue output Ping button Status LED Regulated power out 3 3 V Battery output or power input 3 5 5 5 V Ground 0 V Battery connector s M Lr ae WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 5 1 Input Connections x OSC is equipped with 16 independent input channels which may each be configured to either analogue digital or serial inputs 1 to 4 only modes using a browser or OSC over Wi Fi see sections 7 3 and 7 1 e Digital inputs can be configured to use internal pull up down resistors and to minimise latency their state is only transmitted on change e Analogue inputs may be connected to sensors producing a voltage in the range O 3 3 V Each input is sampled with 13 bit resolution and measurements are transmitted at a specified rate of up to 400 Hz Analogue input mode also provides a compare function to send a message each time a specified threshold is crossed This enables low latency threshold detection without the need for a high message rate e The serial channels su
10. ial x OSC User Manual v0 4 Release date 14 May 2014 lt channel gt 1 4 led rgb three integer arguments range O 255 set the RGB vales for the on board LED led default resets the LED to the network mode colour ping causes x OSC to broadcast its local IP address serial baud lt channel gt integer argument 0 2000000 sets the baud rate for the specified serial channel 1 4 Serial buffer channel integer argument 1 2048 sets the input buffer size for the specified serial channel 1 4 Serial timeout channel the timeout of the input buffer for the specified serial channel 1 4 is set to the value of i 0 1000 ms serial framing lt channel gt integer argument 1 255 sets the framing character for the specified serial channel 1 4 Table 2 host to x OSC message summery WWVW X io co uk
11. indicates a the acquisition time of the data WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 accurate to 14 ns The Use address prefix option allows you to specify a unique prefix address for all incoming and outgoing OSC messages This option can be used to differentiate between messages received on the same port from multiple x OSCs Remote IP KLT 5000 Local IP 169 254 1 1 Port Send bundles nd Use address prefix Address prefix Figure 5 OSC browser settings 7 3 Input Settings The input section is where individual input channels are configured is shown in Figure 6 At the top is the message rate for the analogue input readings 0 0 400 0 Hz Beneath each input channel can be configured as digital or analogue Inputs 1 to 4 can additionally be set to serial as described in section 5 1 In digital mode the pull up down state can be set in analogue mode the comparator threshold can be set range 0 0 1 0 7 4 Output Settings The output section is where the individual output channel modes can be configured Each channel can be set to digital pulse or PWM modes with relevant parameters for each mode as shown in figure Figure 7 and described in section 5 2 WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 Y inputs Analogue rate Hz Input 1 Serial A Channel 1 serial settings below Input 2 Serial Channel 2 serial settings below Input 3
12. mber of purposes When pressed x OSC responds by broadcasting an OSC message indicating its IP and MAC address Pressing and holding for 3 seconds causes x OSC to toggle network modes that is if it is in ad hoc mode it switches to infrastructure mode and vice versa see section 6 Pressing and holding the ping button for longer than 8 seconds invokes a factory reset when the button is released 5 4 Status LED The LED on x OSC indicates the current network mode cyan for ad hoc mode and yellow for infrastructure mode see section 6 In ad hoc mode the LED will flash until its network has been created in infrastructure mode the LED will flash until it has joined the infrastructure network If x OSC fails to join the infrastructure network return to ad hoc mode by pressing and holding the ping WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 button as described in section 5 3 It is also possible to override the LED colour if desired see section 8 6 Connecting to x OSC x OSC can communicate with one or more host computers over a Wi Fi network in either ad hock or infrastructure network modes By default the device uses ad hock mode although this can be changed easily using a standard internet browser see section 7 While the network connection is being established the LED will flash upon successful network configuration the LED will remain on constantly 6 1 Ad hock Mode Cyan LED In ad hoc mode x
13. ogue inputs 0 if below or 1 if above the threshold Sent only when a threshold on any channel is crossed inputs serial channel 1 blob argument containing the raw serial data received on input channel 1 4 imu 10 floating point arguments indicating the current readings of the on board sensors Arguments 1 3 gyroscope s x y z arguments 4 6 accelerometer g x y z arguments 7 9 magnetometer Ga x y z argument 10 gyroscope temperature C battery 1 floating point argument indicating the current battery voltage ping 3 string arguments are the x OSC local IP address 1 string MAC address 2 string and firmware version 3 string Table 1 x OSC to host message summery 8 2 Host to x OSC messages If x OSC receives a message that does not match any message in the following table the LED will flash red Address Pattern Arguments Description osc remote ip string argument specifying the remote ip address in dot decimal notation e g 169 254 1 2 osc remote port integer argument specifying the remote port 0 65535 osc local port integer argument specifying the local port 0 65535 osc bundles integer argument 0 or 1 disables or enables the sending of OSC bundles osc prefix enabled integer argument 0 or 1 disables or enables the OSC address prefix ase profits a string argument specifying the OSC address prefix e g xosc inputs mode analogue lt channel
14. pport baud rates up to 2Mbps with 8 data bits no parity and 1 stop bit Serial data can be framed by specifying a buffer size data timeout and or a framing byte When a complete frame has been received it is transmitted as an OSC blob 5 2 Output Connections The 16 independent output channels on x OSC may each be configured to output digital pulse PWM RGB control or serial outputs 1 to 4 only signals which can also be configured by browser or OSC over Wi Fi see sections 7 3 and 7 1 e In digital mode an output can be set high or low e In pulse mode an output can be triggered to generate a pulse with a period of 1 ms to 1 minute at a resolution of 1 ms n PWM mode an output can generate a PWM waveform from 5 Hz to 250 kHz with a duty cycle resolution up to 16 bit PWM may be used with a fixed frequency and variable duty cycle to approximate an analogue signal e In RGB mode an output may control up to 400 individually addressable RGB LEDs NeoPixel To transmit RGB data the host application should format the pixel data into an OSC blob message in the format Ri Gi Bi Ro Go B Rn Gn Bn where Ri G or B represent the red green and blue bytes value 0 255 for the first LED e Serial output data is sent using the same configuration as the serial inputs To transmit serial data the host application should format the data into an OSC blob message 5 3 Ping button The ping button on the x OSC board serves a nu
15. timeout up to 1000 ms and or a framing byte 0 to 255 Baud Rate Buffer Size Timeout ms Framing Byte Channel 1 Channel 2 Channel 3 Channel 4 Figure 8 Output browser settings 7 6 IMU Settings x OSC is equipped with on board 3D gyroscope accelerometer and magnetometer The IMU settings adjust the rate at which these sensor readings are transmitted over OSC 0 400 Hz Sensor send rate Figure 9 IMU browser settings 8 Communicating with x OSC OSC Dictionary x OSC Implements OSC 1 0 as per the specification with the following exceptions notes e address patterns are not case sensitive float and integer arguments are interchangeable Where floats are used in place of integers their values are rounded character lists e g string or the associated operators un and are not supported This section provides a look up table for the x OSC OSC dictionary WWVW X io co uk x OSC User Manual v0 4 Release date 14 May 2014 8 1 x OSC to host messages Address Pattern Arguments Description inputs digital 16 integer arguments represent the state of the 16 digital inputs 0 or 1 Sent only when the state of any digital input pin changes inputs analogue 16 floating point arguments indicate the analogue readings for all 16 inputs Sent at the analogue input message rate inputs analogue comparator 16 integer arguments represent the current compare state of the 16 anal
Download Pdf Manuals
Related Search